Commit 247e1a97 authored by Alexandre's avatar Alexandre

update: README.md

parent 8e983199
......@@ -21,19 +21,9 @@ More details on each component in the following section.
## Components documentation
### sib-router  &  sib-route
`<sib-router>` accepts the following attributes:
- **default-route**: The `name` attribute of the default `<sib-route>` displayed.
- **route-prefix**: If you app is not run from the root of your domain name, for instance `www.your-domain.com/some-uri`, you should set `route-prefix` to "some-uri".
- **use-hash**: If you can't rewrite the URLs on your server, you might want to set this attribute to `true` to use `location.hash` instead of `location.pathname` as URLs.
`<sib-route>` accepts the following attributes:
Displays a menu and handle the navigation for you.
- **id-prefix**: TO BE WRITTEN
- **active**: This attribute is present on route being displayed by `<sib-router>`. It is automatically added/removed by `<sib-router>` and should not be tinkered manually.
Example :
```html
<sib-router
default-route="list"
......@@ -47,6 +37,18 @@ Example :
```
`<sib-router>` accepts the following attributes:
- **default-route**: The `name` attribute of the default `<sib-route>` displayed.
- **route-prefix**: If you app is not run from the root of your domain name, for instance `www.your-domain.com/some-uri`, you should set `route-prefix` to "some-uri".
- **use-hash**: If you can't rewrite the URLs on your server, you might want to set this attribute to `true` to use `location.hash` instead of `location.pathname` as URLs.
`<sib-route>` accepts the following attributes:
- **id-prefix**: User by `sib-router` to extract the part of the URL that follows the `id-prefix`.
- **active**: This attribute is present on route being displayed by `<sib-router>`. It is automatically added/removed by `<sib-router>` and should not be tinkered manually.
### sib-link
`<sib-link>` accepts the following attributes:
......
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