Newer
Older
Features
#########
We call "mixins" features for SIB components. Basicly they provide attribute to it.
List
=====
[Description]
Attributes available:
--------------------
+------------+-----------------+---------+----------------------------------------+
+===========+=================+=========+=========================================+
| order-by | | | |
+-----------+-----------------+---------+-----------------------------------------+
+-----------+-----------------+---------+-----------------------------------------+
`order-by`, " test ", " test ", " test "
« counter », " test ", " test ", " test "
« else », " test ", " test ", " test "
.. list-table::
:header-rows: 1
:stub-columns: 1
* - Name
- order-by
- counter
* - Expected
- test
- test
* - Default
Used in components:
-------------------
* link to `Sib-Display <SiB-Display>`__
* link to `Sib-Form <SiB-Form>`__
Store
=====
[Description]
Attributes available:
--------------------
+---------------+-----------------+---------+-----------------------------------------+
| Name | expected | Default | Description |
+=======+=========================+=========+=========================================+
| nested-field | | | |
+---------------+-----------------+---------+-----------------------------------------+
| | | | |
+---------------+-----------------+---------+-----------------------------------------+
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
Used in components:
-------------------
* link to `Sib-Display <SiB-Display>`__
* link to `Sib-Form <SiB-Form>`__
Events
######
Some event are available on specific wiget. You'll find corresponding events for your components in its documentation.
+------------+-----------------+---------+----------------------------------------+
| Event name | Parameters | Fired by | Fired when |
+=======+=====================+=========+=========================================+
| `resourceSelect` | `{detail:{resource}}` | `sib-display`, `sib-calendar`, `sib-map` | The user clicks an child in the list, with the resource as a detail of the event. |
+-----------+-----------------+---------+-----------------------------------------+
| `populate` | `{detail:{resource}}` | `sib-display`, `sib-form`, `sib-calendar`, `sib-map` | The component got and displayed all its datas. |
+-----------+-----------------+---------+-----------------------------------------+
| `save` | `{detail:{resource}}` | `sib-form` | The form has saved successfully. |
+-----------+-----------------+---------+-----------------------------------------+
Examples
========
Populate
--------
Use to do something if and when the element is generated.
.. code:: js
element.addEventListener("populate", event => {
// Do something when the element is generated.
})
Save
----
Use to do something when a form is successfully saved.
.. code:: js
form.addEventListener("save", event => {
// Do something when the form has been successfully saved.
});