0.2.4 • Published 2 years ago

@dbp-toolkit/organization-select v0.2.4

Weekly downloads
-
License
LGPL-2.1-or-later
Repository
gitlab
Last release
2 years ago

Organization Select Web Component

You can install this component via npm:

npm i @dbp-toolkit/organization-select

Usage

<dbp-organization-select></dbp-organization-select>
<script type="module" src="node_modules/@dbp-toolkit/organization-select/dist/dbp-organization-select.js"></script>

Or directly via CDN:

<dbp-organization-select></dbp-organization-select>
<script type="module" src="https://unpkg.com/@dbp-toolkit/organization-select@0.2.2/dist/dbp-organization-select.js"></script>

Attributes

  • lang (optional, default: de): set to de or en for German or English
    • example <dbp-organization-select lang="de"></dbp-organization-select>
  • entry-point-url (optional, default is the TU Graz entry point url): entry point url to access the api
    • example <dbp-organization-select entry-point-url="http://127.0.0.1:8000"></dbp-organization-select>
  • value (optional): api path of organization to preload the selector with
    • example <dbp-organization-select value="/base/people/testuser"></dbp-organization-select>
    • the value will also be set automatically when an organization is chosen in the selector
  • context (optional): the context of the returned organizations
    • example <dbp-organization-select context="libray-manager"></dbp-organization-select> returns all organizations where the current user is library manager
    • if no context is set all organizations are returned that are in a relation with the current user
  • data-object (read-only): when an organization is selected the organization object will be set as json string
    • example <dbp-organization-select data-object="{"@id":"/organizations/1190-F2050","@type":"http://schema.org/Organization","identifier":"1190-F2050","name":"Institut für Stahlbau","url":"https://online.tugraz.at/tug_online/wborg.display?pOrgNr=1190","alternateName":"F2050"}"></dbp-organization-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

# get the source
git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
cd toolkit/packages/organization-select

# install dependencies
yarn install

# constantly build dist/bundle.js and run a local web-server on port 8002 
yarn run watch

# run tests
yarn test

# build local packages in dist directory
yarn run build

Jump to http://localhost:8002 and you should get a Single Sign On login page.