Skip to content
Snippets Groups Projects
Unverified Commit a3374141 authored by Bekerle, Patrizio's avatar Bekerle, Patrizio :fire:
Browse files

Add more documentation

parent 6ecf4fea
No related branches found
No related tags found
No related merge requests found
Pipeline #16687 passed
...@@ -60,6 +60,14 @@ The component emits a `dbp-set-property` event for the attribute `auth`: ...@@ -60,6 +60,14 @@ The component emits a `dbp-set-property` event for the attribute `auth`:
<script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script> <script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script>
``` ```
### Attributes
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
- example `<dbp-auth-keycloak lang="de" </dbp-auth-keycloak>`
- `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development ## Local development
```bash ```bash
......
...@@ -34,6 +34,7 @@ npm i @dbp-toolkit/check-in-place-select ...@@ -34,6 +34,7 @@ npm i @dbp-toolkit/check-in-place-select
- example `<dbp-check-in-place-select show-reload-button reload-button-text="Reload result list"></dbp-check-in-place-select>` - example `<dbp-check-in-place-select show-reload-button reload-button-text="Reload result list"></dbp-check-in-place-select>`
- `auth` object: you need to set that object property for the auth token - `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}` - example auth property: `{token: "THE_BEARER_TOKEN"}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development ## Local development
......
/**
* EventBus system
*
* DEPRECATED: Migrated to provider
*/
const OPERATION_FETCH_RETAINED = 'fetch-retained'; const OPERATION_FETCH_RETAINED = 'fetch-retained';
......
...@@ -24,7 +24,8 @@ npm i @dbp-toolkit/knowledge-base-web-page-element-view ...@@ -24,7 +24,8 @@ npm i @dbp-toolkit/knowledge-base-web-page-element-view
- `text` (optional): text to click to show the information loaded from the webpage - `text` (optional): text to click to show the information loaded from the webpage
- example `<dbp-knowledge-base-web-page-element-view text="Click me to show more information"></dbp-knowledge-base-web-page-element-view>` - example `<dbp-knowledge-base-web-page-element-view text="Click me to show more information"></dbp-knowledge-base-web-page-element-view>`
- `auth` object: you need to set that object property for the auth token - `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}` - example auth property: `{token: "THE_BEARER_TOKEN"}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development ## Local development
......
...@@ -22,7 +22,8 @@ npm i @dbp-toolkit/person-profile ...@@ -22,7 +22,8 @@ npm i @dbp-toolkit/person-profile
- `value` (optional): api path of person to preload the selector with - `value` (optional): api path of person to preload the selector with
- example `<dbp-person-profile value="/people/testuser"></dbp-person-profile>` - example `<dbp-person-profile value="/people/testuser"></dbp-person-profile>`
- `auth` object: you need to set that object property for the auth token - `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}` - example auth property: `{token: "THE_BEARER_TOKEN"}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development ## Local development
......
...@@ -34,7 +34,8 @@ npm i @dbp-toolkit/person-select ...@@ -34,7 +34,8 @@ npm i @dbp-toolkit/person-select
- `reload-button-title` (optional): sets a title text on the reload button - `reload-button-title` (optional): sets a title text on the reload button
- example `<dbp-person-select show-reload-button reload-button-text="Reload result list"></dbp-person-select>` - example `<dbp-person-select show-reload-button reload-button-text="Reload result list"></dbp-person-select>`
- `auth` object: you need to set that object property for the auth token - `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}` - example auth property: `{token: "THE_BEARER_TOKEN"}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development ## Local development
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment