diff --git a/source/import_documentation/Components/SiB-Ac-Checker.rst b/source/import_documentation/Components/SiB-Ac-Checker.rst index d6c0febc0d9cddcf590d4a6dbc81a83c6c20a98f..321909c7435cda123fe684f8c5080bb64cc26ac1 100644 --- a/source/import_documentation/Components/SiB-Ac-Checker.rst +++ b/source/import_documentation/Components/SiB-Ac-Checker.rst @@ -1,5 +1,5 @@ sib-ac-checker -~~~~~~~~~~~~~~ +============== Hides an element from the page if the current user doesn’t have the required permissions on it. diff --git a/source/import_documentation/Components/SiB-Delete.rst b/source/import_documentation/Components/SiB-Delete.rst index 27656f818679fb9bf45a0c576a289f1329aec137..3c47f3fd2432b96f1325d0c2d89786f33876ffab 100644 --- a/source/import_documentation/Components/SiB-Delete.rst +++ b/source/import_documentation/Components/SiB-Delete.rst @@ -1,5 +1,5 @@ sib-delete -~~~~~~~~~~ +=========== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays a button to delete it when clicked. diff --git a/source/import_documentation/Components/SiB-Display.rst b/source/import_documentation/Components/SiB-Display.rst index 0347ef917ee3b96f51c7f2dbdcd98f319930a4d1..dbf5d35675efe97f216dbef0c0f950cc0d1c5724 100644 --- a/source/import_documentation/Components/SiB-Display.rst +++ b/source/import_documentation/Components/SiB-Display.rst @@ -1,5 +1,5 @@ sib-display -~~~~~~~~~~~ +=========== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it. Each field of the displayed diff --git a/source/import_documentation/Components/SiB-Form.rst b/source/import_documentation/Components/SiB-Form.rst index fe7edd6c2b34a8bbda2537bd6fe01fb1ed7859da..b1eb377e857b7fed9a55a352c60918d11125bdd1 100644 --- a/source/import_documentation/Components/SiB-Form.rst +++ b/source/import_documentation/Components/SiB-Form.rst @@ -1,5 +1,5 @@ sib-form -~~~~~~~~ +========= Receives the URL of a ressource via its ``data-src`` attribute, and displays a form to edit the resource. If given the URL of a container of diff --git a/source/import_documentation/Components/SiB-Map.rst b/source/import_documentation/Components/SiB-Map.rst index f67f344409f66fe4202e81e920d2867e808331a6..c66ae4f00bff6a3981bb11f82df94d8ce8f5f648 100644 --- a/source/import_documentation/Components/SiB-Map.rst +++ b/source/import_documentation/Components/SiB-Map.rst @@ -1,5 +1,5 @@ sib-map -~~~~~~~ +======== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it on a **map**. Here is the list diff --git a/source/import_documentation/Components/SiB-Widget.rst b/source/import_documentation/Components/SiB-Widget.rst index 4da83648f67a6707ae107959688e3cbc6ca4c029..76252c9d713615b6cd2f8752ce3075ed5dbf1ba8 100644 --- a/source/import_documentation/Components/SiB-Widget.rst +++ b/source/import_documentation/Components/SiB-Widget.rst @@ -1,5 +1,5 @@ sib-widget -~~~~~~~~~~ +=========== Take a ``name`` as an attribute and a HTML template, and create an HTML custom element you can use as a widget. i.e. diff --git a/source/import_documentation/Components/Sib-Calendar.rst b/source/import_documentation/Components/Sib-Calendar.rst index 6f35a6ba96a7aae350ff530a1e46f1fcb74f3cc7..2e356ae172fd963fb87d698ede7fadf2dc4f234f 100644 --- a/source/import_documentation/Components/Sib-Calendar.rst +++ b/source/import_documentation/Components/Sib-Calendar.rst @@ -1,5 +1,5 @@ sib-calendar -~~~~~~~~~~~~ +============ Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it in a **calendar**. Here is the diff --git a/source/import_documentation/Components/community-components.rst b/source/import_documentation/Components/community-components.rst new file mode 100644 index 0000000000000000000000000000000000000000..c59e2704aec71436600785d1d10821d76346e5a1 --- /dev/null +++ b/source/import_documentation/Components/community-components.rst @@ -0,0 +1,14 @@ +The community components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget diff --git a/source/import_documentation/Components/framework-components.rst b/source/import_documentation/Components/framework-components.rst new file mode 100644 index 0000000000000000000000000000000000000000..2df5ccdbe7f2a9af53699323d004facd8fabd788 --- /dev/null +++ b/source/import_documentation/Components/framework-components.rst @@ -0,0 +1,15 @@ +The framework components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget + diff --git a/source/import_documentation/Components/index.rst b/source/import_documentation/Components/index.rst index a3d4aff29d1e759ad4d1c19ef8cbbb42377ddfd1..81514e3b78dbfb93f0acf33f1beebeac495f7d5d 100644 --- a/source/import_documentation/Components/index.rst +++ b/source/import_documentation/Components/index.rst @@ -1,5 +1,6 @@ +************ Components -========== +************ .. toctree:: :maxdepth: 2 diff --git a/source/import_documentation/Components/official-components.rst b/source/import_documentation/Components/official-components.rst new file mode 100644 index 0000000000000000000000000000000000000000..2c236b3669b06aa9b95111beaca273cded944e77 --- /dev/null +++ b/source/import_documentation/Components/official-components.rst @@ -0,0 +1,14 @@ +The official components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget diff --git a/source/import_documentation/build-full-application.rst b/source/import_documentation/build-full-application.rst index 50137714b7dd0c54a886905d963183f98ff40791..3ef2cf37d8e46fb812136c970d37453295717c6d 100644 --- a/source/import_documentation/build-full-application.rst +++ b/source/import_documentation/build-full-application.rst @@ -9,8 +9,9 @@ With the core of the framework and some offical components, we'll be able to bui To start, simply import the core in your HTML file: .. code:: html - <!-- ... Import the core ... --> - <script type="module" src="https://unpkg.com/@startinblox/core"></script> + <!-- ... Import the core ... --> + <script type="module" src="https://unpkg.com/@startinblox/core"></script> + </head> 2. Use core components diff --git a/source/index.rst b/source/index.rst index 49fe3f8aba082644818c4717d5ceaf9f6d38ea9e..1b2b81523fc8468a2521f6626ab7d5535f5d8a19 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,6 +9,7 @@ Welcome to Startinblox's documentation! import_documentation/Use-a-component-alone-in-an-existing-application import_documentation/build-full-application import_documentation/the-basics + import_documentation/Components/index import_documentation/Documentation-Component-Model import_documentation/Events import_documentation/Helpers-functions