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

Add css variable documentation and bump versions

parent be633923
No related branches found
No related tags found
No related merge requests found
Pipeline #44729 failed
...@@ -13,3 +13,10 @@ For valid icon names see: [LineIcons](https://lineicons.com/icons/) ...@@ -13,3 +13,10 @@ For valid icon names see: [LineIcons](https://lineicons.com/icons/)
```html ```html
<dbp-icon color="orange" name="menu-down"></dbp-icon> <dbp-icon color="orange" name="menu-down"></dbp-icon>
``` ```
### Exposed CSS variables
Variables like `--dbp-override-icon-<icon-name>` can be used to override the icons.
Example CSS: `html { --dbp-override-icon-cloud: url(/icons/cloud.svg); }`
{ {
"name": "@dbp-toolkit/common", "name": "@dbp-toolkit/common",
"homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/common", "homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/common",
"version": "0.2.3", "version": "0.2.4",
"module": "index.js", "module": "index.js",
"license": "LGPL-2.1-or-later", "license": "LGPL-2.1-or-later",
"repository": { "repository": {
......
...@@ -104,11 +104,15 @@ This event is sent if a file was selected. ...@@ -104,11 +104,15 @@ This event is sent if a file was selected.
This event is sent if multiple files are selected. This event is sent if multiple files are selected.
#### `dbp-nextcloud-file-picker-number-files` #### `dbp-nextcloud-file-picker-number-files`
This event is sent from nextcloudfilepicker and is send when files are picked and sends the number of selected files This event is sent from nextcloudfilepicker and is send when files are picked and sends the number of selected files
**Payload**: `{'file': File}` where [File](https://developer.mozilla.org/en-US/docs/Web/API/File) is the binary file that was selected
### Exposed CSS variables
**Payload**: `{'file': File}` where [File](https://developer.mozilla.org/en-US/docs/Web/API/File) is the binary file that was selected - `--dbp-override-image-nextcloud` is used to override the cloud image on the connection screen
- example CSS: `html { --dbp-override-image-nextcloud: url(/icons/nextcloud.svg); }`
## FileSink ## FileSink
...@@ -162,6 +166,11 @@ The component emits a `dbp-set-property` event for the attribute `initial-file-h ...@@ -162,6 +166,11 @@ The component emits a `dbp-set-property` event for the attribute `initial-file-h
- if the property is set the dialog opens - if the property is set the dialog opens
- example: `document.querySelector("dbp-file-sink").files = [file]` where `file` is your File object - example: `document.querySelector("dbp-file-sink").files = [file]` where `file` is your File object
### Exposed CSS variables
- `--dbp-override-image-nextcloud` is used to override the cloud image on the connection screen
- example CSS: `html { --dbp-override-image-nextcloud: url(/icons/nextcloud.svg); }`
## Local development ## Local development
```bash ```bash
......
{ {
"name": "@dbp-toolkit/file-handling", "name": "@dbp-toolkit/file-handling",
"homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/file-handling", "homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/file-handling",
"version": "0.2.3", "version": "0.2.4",
"main": "src/index.js", "main": "src/index.js",
"license": "LGPL-2.1-or-later", "license": "LGPL-2.1-or-later",
"repository": { "repository": {
......
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