Adds itemSize property

This commit is contained in:
Alicia Sykes 2021-04-18 13:57:20 +01:00
parent 78ebcbfa0a
commit 375ab032cd
3 changed files with 9 additions and 3 deletions

View File

@ -75,6 +75,7 @@ All fields are optional, unless otherwise stated.
- `cols` - Int: Number of columns the section should span horizontally, e.g. 2 (defaults to `1`) - `cols` - Int: Number of columns the section should span horizontally, e.g. 2 (defaults to `1`)
- `color` - String: A custom background color for the section, as a hex code or HTML color (e.g. `#fff`) - `color` - String: A custom background color for the section, as a hex code or HTML color (e.g. `#fff`)
- `customStyles` - String: Custom CSS properties that should be applied to that section, e.g. `border: 2px dashed #ff0000;` - `customStyles` - String: Custom CSS properties that should be applied to that section, e.g. `border: 2px dashed #ff0000;`
- `itemSize` - String: Specify the size for items within this group, either `small`, `medium` or `large`
**`item`** **`item`**
- `title` - String: The text to display on the item - `title` - String: The text to display on the item
@ -87,9 +88,10 @@ All fields are optional, unless otherwise stated.
**`icon`** Examples: **`icon`** Examples:
- To use use a remote image, just use it's full URL, e.g. `https://i.ibb.co/710B3Yc/space-invader-x256.png` - To use use a remote image, just use it's full URL, e.g. `https://i.ibb.co/710B3Yc/space-invader-x256.png`
- To use a local image, save it in `./public/item-icons/` or `./public/my-category/item-icons` and specify the image as `image.png` or `my-category/image.png`. For best results, use either png or svg formats. - To use a local image, save it in `./public/item-icons/` or `./public/my-category/item-icons` and specify the image as `image.png` or `my-category/image.png`. For best results, use either png or svg formats.
- To automatically fetch the icons from the website's URL, just set icon to `favicon` - To automatically fetch an icon from items URL, just set icon field to `favicon`
- To use a Font-Awesome icon, specify the category (`fas`, `fab`, `far`, `fal` or`fad`), followed by a space then `fa-` and the icon name. For example: `fas fa-rocket`, `fab fa-monero`, `fal fa-duck` or `fad fa-glass-whiskey-rocks`. Note that light (`fal`) and duotone (`fad`) icons are only available with Font Awesome Pro, to use this, you need to set you're kit ID under `appConfig.fontAwesomeKey`. - To use a Font-Awesome icon, specify the category (`fas`, `fab`, `far`, `fal` or`fad`), followed by a space then `fa-` and the icon name. For example: `fas fa-rocket`, `fab fa-monero`, `fal fa-duck` or `fad fa-glass-whiskey-rocks`. Note that light (`fal`) and duotone (`fad`) icons are only available with Font Awesome Pro, to use this, you need to set you're kit ID under `appConfig.fontAwesomeKey`.
--- ---
## License 📜 ## License 📜

View File

@ -33,7 +33,6 @@ export default {
subtitle: String, // Optional sub-text subtitle: String, // Optional sub-text
description: String, // Optional tooltip hover text description: String, // Optional tooltip hover text
icon: String, // Optional path to icon, within public/img/tile-icons icon: String, // Optional path to icon, within public/img/tile-icons
svg: String, // Optional vector graphic, that is then dynamically filled
color: String, // Optional background color, specified in hex code color: String, // Optional background color, specified in hex code
url: String, // URL to the resource, optional but recommended url: String, // URL to the resource, optional but recommended
target: { // Where resource will open, either 'newtab', 'sametab' or 'iframe' target: { // Where resource will open, either 'newtab', 'sametab' or 'iframe'

View File

@ -21,7 +21,7 @@
:description="item.description" :description="item.description"
:icon="item.icon" :icon="item.icon"
:target="item.target" :target="item.target"
:itemSize="itemSize" :itemSize="newItemSize"
@itemClicked="$emit('itemClicked')" @itemClicked="$emit('itemClicked')"
@triggerModal="triggerModal" @triggerModal="triggerModal"
/> />
@ -54,6 +54,11 @@ export default {
Item, Item,
IframeModal, IframeModal,
}, },
computed: {
newItemSize: function size() {
return this.displayData.itemSize || this.itemSize;
},
},
methods: { methods: {
/* Returns a unique lowercase string, based on name, for section ID */ /* Returns a unique lowercase string, based on name, for section ID */
makeId(str) { makeId(str) {