diff --git a/admin/tool/componentlibrary/content/library/example-files.md b/admin/tool/componentlibrary/content/library/example-files.md index 9b62ca16797..04dae720404 100644 --- a/admin/tool/componentlibrary/content/library/example-files.md +++ b/admin/tool/componentlibrary/content/library/example-files.md @@ -7,12 +7,12 @@ draft: false There may be times that we need to provide example implementations of the component being documented in order to further demonstrate how to use a component. -We need to put these files in `examples` folders. It helps organise things and makes the maintenance of the component library code easier by allowing us to distinguish examples from the actual component library code. +We need to put these files in `examples` folders. It helps organise things and makes the maintenance of the component library code easier by allowing us to distinguish examples from the actual component library code. ## Example pages -Example pages can be placed under the `componentlibrary/examples` folder. +Example pages can be placed under the `componentlibrary/examples` folder. See the `formfields.php` example page as an example: @@ -30,7 +30,7 @@ This can be embedded in the component's documentation page via iframe. For examp ## Example classes -Example classes can be placed under the `componentlibrary/classes/local/examples/[componentname]` folder. +Example classes can be placed under the `componentlibrary/classes/local/examples/[componentname]` folder. In our form fields example, we have the `\tool_componentlibrary\local\examples\formelements\example` class under `componentlibrary/classes/local/examples/formelements`.