Skip to content
Snippets Groups Projects
Commit 7c92f43f authored by Tögl, Christina's avatar Tögl, Christina
Browse files

Change text in README (#34)

parent 1e24e42b
No related branches found
No related tags found
1 merge request!5Rename component to dbp-check-in-place-select (#34)
Pipeline #14020 passed
# check-in-place Select Web Component # Check-in place select web component
[GitLab Repository](https://gitlab.tugraz.at/dbp/web-components/toolkit) [GitLab Repository](https://gitlab.tugraz.at/dbp/web-components/toolkit)
...@@ -14,16 +14,16 @@ ...@@ -14,16 +14,16 @@
- example `<dbp-check-in-place-select lang="de"></dbp-check-in-place-select>` - example `<dbp-check-in-place-select lang="de"></dbp-check-in-place-select>`
- `entry-point-url` (optional, default is the TU Graz entry point url): entry point url to access the api - `entry-point-url` (optional, default is the TU Graz entry point url): entry point url to access the api
- example `<dbp-check-in-place-select entry-point-url="http://127.0.0.1:8000"></dbp-check-in-place-select>` - example `<dbp-check-in-place-select entry-point-url="http://127.0.0.1:8000"></dbp-check-in-place-select>`
- `value` (optional): api path of check-in-place to preload the selector with - `value` (optional): api path of place to preload the selector with
- example `<dbp-check-in-place-select value="Besprechungsraum"></dbp-check-in-place-select>` - example `<dbp-check-in-place-select value="Besprechungsraum"></dbp-check-in-place-select>`
- the `value` will also be set automatically when a check-in-place is chosen in the selector - the `value` will also be set automatically when a place is chosen in the selector
- `data-object` (read-only): when a check-in-place is selected the check-in-place object will be set as json string - `data-object` (read-only): when a place is selected the place object will be set as json string
- example `<dbp-check-in-place-select data-object="{"@id":"id", "@type":"http://schema.org/Place", "identifier":"id", "name":"Besprechungsraum", "maximumPhysicalAttendeeCapacity":"50"}"></dbp-check-in-place-select>` - example `<dbp-check-in-place-select data-object="{"@id":"id", "@type":"http://schema.org/Place", "identifier":"id", "name":"Besprechungsraum", "maximumPhysicalAttendeeCapacity":"50"}"></dbp-check-in-place-select>`
- `show-capacity` (optional): also shows the capacity of the check-in-places - `show-capacity` (optional): also shows the capacity of the places
- example `<dbp-check-in-place-select show-capacity></dbp-check-in-place-select>` - example `<dbp-check-in-place-select show-capacity></dbp-check-in-place-select>`
- `show-reload-button` (optional): if set a reload button will be viewed next to the select box - `show-reload-button` (optional): if set a reload button will be viewed next to the select box
- the button triggers a `change` event on the web component - the button triggers a `change` event on the web component
- the button is disabled if no check-in-place is selected - the button is disabled if no place is selected
- example `<dbp-check-in-place-select show-reload-button></dbp-check-in-place-select>` - example `<dbp-check-in-place-select show-reload-button></dbp-check-in-place-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-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>`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment