Skip to content
Snippets Groups Projects
the-basics.rst 3.54 KiB
Newer Older
Alice Poggioli's avatar
Alice Poggioli committed
Parties
#######

Chapitre
**********

Section
========

Sous Section
------------
sousoussectiion
^^^^^^^^^^^^^^
paragraphe
""""""""""

Alice Poggioli's avatar
Alice Poggioli committed
How works a Component ?
-----------------------

A component is a simple tag. Each component has its own attributes that
allow us to customize its behavior.

Let’s see an exemple with sib-display :

.. code:: html

   <sib-display
     data-src="http://api.myadress.com/users/"
     fields="first_name, last_name"
   ></sib-display>

This code will retrieve the data from the uri assigned to the data-src
attribute and display all fields present in the field attribute. See the
full explanation on `the doc of SiB Display <Components/SiB-Display>`__.


Default component available in the core
---------------------------------------

By importing the Startin’blox core, the following main components are
available :

-  `SiB Display <Components/SiB-Display>`__ - To display datas
-  `SiB Form <Components/SiB-Form>`__ - To display a form
-  `SiB Delete <Components/SiB-Delete>`__ - To delete datas
-  `SiB Ac Checker <Components/SiB-Ac-Checker>`__ - To manage permission
-  `Sib Widget <Components/SiB-Widget>`__ - To custom your rendering
-  `SiB Calendar <Components/SiB-Calendar>`__ - To display a calendar
-  `SiB Map <Components/SiB-Map>`__ - To display a map

Imagine your components !
-------------------------

There is `a tutorial <./How%20to%20make%20components%20?>`__ to learn
how to create your own components.

If you have any difficulties, don’t hesitate to ask people on `our
chat <community.startinblox.com>`__ :)
Alice Poggioli's avatar
Alice Poggioli committed
Core Components
---------------

Here you’ll find the documentation for each component of the core :

-  `SiB Display <Components/SiB-Display>`__ - To display datas
-  `SiB Form <Components/SiB-Form>`__ - To display a form
-  `SiB Delete <Components/SiB-Delete>`__ - To delete datas
-  `SiB Ac Checker <Components/SiB-Ac-Checker>`__ - To manage permission
-  `Sib Widget <Components/SiB-Widget>`__ - To custom your rendering
-  `SiB Calendar <Components/SiB-Calendar>`__ - To display a calendar
-  `SiB Map <Components/SiB-Map>`__ - To display a map

Framework Component
-------------------

Some very useful components aren’t in the core as you can just import
what you need. You’ll see how to do that in their own documentation.
**Those components need the core to work.**

-  `SiB
   Router <https://git.happy-dev.fr/startinblox/framework/sib-router/wikis/SiB-Router>`__
   - Displays a menu and handle the navigation for you.
-  `SiB
   OIDC <https://git.happy-dev.fr/startinblox/framework/sib-oidc/wikis/Sib-OIDC>`__
   - To login with an OIDC provider.
-  `SiB
   Generator <https://git.happy-dev.fr/startinblox/framework/sib-generator/wikis/SiB-Generator>`__
   - Convert content to pdf and initiate a download of the pdf file in
   the browser.
-  `SiB
   Notification <https://git.happy-dev.fr/startinblox/framework/sib-notifications/wikis/SiB-Notification>`__
   - To get notifications, which include `SiB
   Badge <https://git.happy-dev.fr/startinblox/framework/sib-notifications/wikis/SiB-Badge>`__
   to see the number of unread inbox.

Other Components
----------------

As use cases arise, new components are developed. **Those components do
not need the core to work.** Here is a list of those that have been
developed by Startin’ Blox so far:

-  `SiB
   Conversation <https://git.happy-dev.fr/startinblox/components/sib-conversation/wikis/SIB-Conversation>`__
   - To make a “facebook-like” conversation.

Imagine your components !
^^^^^^^^^^^^^^^^^^^^^^^^^

There is a tutorial to learn how to create your own components.