Commit bcd09cbc authored by Matthieu Fesselier's avatar Matthieu Fesselier

update doc

parent ac2d2504
Pipeline #3702 passed with stage
in 28 seconds
......@@ -34,4 +34,26 @@ For example:
:root{
--sib-notifications-theme: #ffd759;
}
```
# SiB Badge
sib-badge is a component that displays the number of unread notifications in the inbox of the logged in user related to a resource or a container.
As it uses the `bind-user`, you have to make sure to include a valid `sib-auth` configuration.
## Usage
In your template, insert the following line where you want to display the component.
```html
<sib-badge data-src="http://server/resourceId"></sib-badge>
```
### Design
To customize your component, you can set the css variable `--sib-badge-theme` anywhere in your stylesheet to the color you want.
For example:
```css
:root{
--sib-badge-theme: #ffd759;
}
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment