You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

117 lines
2.7 KiB

DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
DOC-3186: Update Blazor public documentation (#3724) * Update Blazor Tiny Cloud page * Add instructions for VS Code * Update quick start content structure and add Zip instruction * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Update modules/ROOT/partials/integrations/blazor-quick-start.adoc Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * Add 'link:' prefix to hyperlinks * Add step to include either the API key or License Key based on product source * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * DOC-3186: replace your-api-key with no-api-key. * Fix missing tag in example code --------- Co-authored-by: Sorita Heng <sorita.heng@tiny.cloud> Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com>
3 months ago
4 years ago
  1. . Verify the installation by checking the `+ItemGroup+` references in the project file. For example, if the project is named _BlazorApp_, the relevant file would be `+BlazorApp.csproj+` with the dependency referenced as follows:
  2. +
  3. [source,xml]
  4. ----
  5. <ItemGroup>
  6. <PackageReference Include="TinyMCE.Blazor" Version="X.Y.Z" />
  7. </ItemGroup>
  8. ----
  9. . Add the `+tinymce-blazor.js+` script to the main page. If using the Blazor Web App, add the script in `+Components/App.razor+`, for example:
  10. +
  11. [source,html]
  12. ----
  13. <script src="_framework/blazor.web.js"></script>
  14. <script src="_content/TinyMCE.Blazor/tinymce-blazor.js"></script>
  15. ----
  16. +
  17. [NOTE]
  18. ====
  19. The location of the script depends on the type of Blazor app, including Blazor Server and Blazor WebAssembly (WASM) which are not covered in this guide.
  20. * If using Blazor Server, add the script in `+Pages/_Host.cshtml+`, for example:
  21. +
  22. [source,html]
  23. ----
  24. <script src="_framework/blazor.server.js"></script>
  25. <script src="_content/TinyMCE.Blazor/tinymce-blazor.js"></script>
  26. ----
  27. * If using WASM, add the script in `+wwwroot/index.html+`, for example:
  28. +
  29. [source,html]
  30. ----
  31. <script src="_content/TinyMCE.Blazor/tinymce-blazor.js"></script>
  32. <script src="_framework/blazor.webassembly.js"></script>
  33. ----
  34. ====
  35. +
  36. . Add the `+Editor+` component to a page by either:
  37. * Using the `+using+` directive:
  38. +
  39. [source,cs]
  40. ----
  41. @using TinyMCE.Blazor
  42. <Editor />
  43. ----
  44. +
  45. For example:
  46. +
  47. _File:_ `+Pages/Index.razor+`
  48. +
  49. [source,cs]
  50. ----
  51. @page "/"
  52. @rendermode InteractiveServer
  53. @using TinyMCE.Blazor
  54. <h1>Hello, world!</h1>
  55. <h2>Welcome to your new app.</h2>
  56. <Editor />
  57. ----
  58. * Using the component with its namespace:
  59. +
  60. [source,cs]
  61. ----
  62. <TinyMCE.Blazor.Editor />
  63. ----
  64. +
  65. For example:
  66. +
  67. _File:_ `+Pages/Index.razor+`
  68. +
  69. [source,cs]
  70. ----
  71. @page "/"
  72. @rendermode InteractiveServer
  73. @using TinyMCE.Blazor
  74. <h1>Hello, world!</h1>
  75. <h2>Welcome to your new app.</h2>
  76. <Editor />
  77. ----
  78. +
  79. [IMPORTANT]
  80. In a Blazor Web App, different render modes determine how components are rendered and how interactivity is handled. To enable JavaScript interactivity, ensure that `+@rendermode InteractiveServer+` is specified in a page component.
  81. +
  82. ifeval::["{productSource}" == "cloud"]
  83. . Update the `+ApiKey+` option in the editor element and include your link:{accountsignup}/[{cloudname} API key].
  84. +
  85. [source,cs]
  86. ----
  87. <Editor ApiKey="no-api-key" />
  88. ----
  89. +
  90. endif::[]
  91. ifeval::["{productSource}" != "cloud"]
  92. . Update the `+LicenseKey+` option in the editor element and include your xref:license-key.adoc[License Key].
  93. +
  94. [source,cs]
  95. ----
  96. <Editor LicenseKey="your-license-key" />
  97. ----
  98. +
  99. . To load {productname} from the self-hosted package instead of the {cloudname}, configure the `+ScriptSrc+` property:
  100. +
  101. [source,cs]
  102. ----
  103. <Editor
  104. ScriptSrc="/path/to/tinymce.min.js"
  105. />
  106. ----
  107. endif::[]