diff --git a/packages/auth/README.md b/packages/auth/README.md index 238f9e16048fca1b3f818ab55f7faeb2c131166c..c017ac9ec0731619b80aed7216096f76fc0f0ecc 100644 --- a/packages/auth/README.md +++ b/packages/auth/README.md @@ -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> ``` +### 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 ```bash diff --git a/packages/check-in-place-select/README.md b/packages/check-in-place-select/README.md index 65a933009e8ed49e7121176889163fe76fe57e3e..a7290e9423681bb72b51bb99564e25a5a49b2771 100644 --- a/packages/check-in-place-select/README.md +++ b/packages/check-in-place-select/README.md @@ -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>` - `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 diff --git a/packages/common/src/eventbus.js b/packages/common/src/eventbus.js index f9cc4b1217355d2993b91f1c7a0930bddd23b468..d77662e9c523b7d68fe3f6e2b6a104c886611393 100644 --- a/packages/common/src/eventbus.js +++ b/packages/common/src/eventbus.js @@ -1,3 +1,8 @@ +/** + * EventBus system + * + * DEPRECATED: Migrated to provider + */ const OPERATION_FETCH_RETAINED = 'fetch-retained'; diff --git a/packages/knowledge-base-web-page-element-view/README.md b/packages/knowledge-base-web-page-element-view/README.md index 82a96017d95f50635d4e0afdd2edc721cce6a0d6..99ad0fd59a1dea6ed72bdee74d95aed964ec8f7f 100644 --- a/packages/knowledge-base-web-page-element-view/README.md +++ b/packages/knowledge-base-web-page-element-view/README.md @@ -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 - 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 - - 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 diff --git a/packages/person-profile/README.md b/packages/person-profile/README.md index 6918a0237014b9e9ec5e34f9eb1fc3bd555e66ad..44880913d9eacd1509ce7dec01ab478c8c366ea5 100644 --- a/packages/person-profile/README.md +++ b/packages/person-profile/README.md @@ -22,7 +22,8 @@ npm i @dbp-toolkit/person-profile - `value` (optional): api path of person to preload the selector with - example `<dbp-person-profile value="/people/testuser"></dbp-person-profile>` - `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 diff --git a/packages/person-select/README.md b/packages/person-select/README.md index 64590b3630e4a3116045b0bf58e8b1cae23b1ec6..c9f31fe233482a7dac923ba240f1371cd2a3ee7b 100644 --- a/packages/person-select/README.md +++ b/packages/person-select/README.md @@ -34,7 +34,8 @@ npm i @dbp-toolkit/person-select - `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>` - `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