From c8961207187519b15db40d60c9ed8b914db05b37 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sat, 2 Oct 2021 18:25:48 +0100 Subject: [PATCH] :card_file_box: (#250) Adds colCount to schema and docs --- docs/configuring.md | 3 ++- src/utils/ConfigSchema.json | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/configuring.md b/docs/configuring.md index 938acac7..d58dc1f2 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -82,8 +82,9 @@ Tips: **`fontAwesomeKey`** | `string` | _Optional_ | If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. `13014ae648`) **`faviconApi`** | `enum` | _Optional_ | Only applicable if you are using favicons for item icons. Specifies which service to use to resolve favicons. Set to `local` to do this locally, without using an API. Services running locally will use this option always. Available options are: `local`, `faviconkit`, `google`, `clearbit`, `webmasterapi` and `allesedv`. Defaults to `faviconkit`. See [Icons](/docs/icons.md#favicons) for more info **`auth`** | `object` | _Optional_ | All settings relating to user authentication. See [`auth`](#appconfigauth-optional) -**`layout`** | `enum` | _Optional_ | App layout, either `horizontal`, `vertical`, `auto` or `sidebar`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified from the UI. +**`layout`** | `enum` | _Optional_ | Layout for homepage, either `horizontal`, `vertical` or `auto`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified and overridden from the UI. **`iconSize`** | `enum` | _Optional_ | The size of link items / icons. Can be either `small`, `medium,` or `large`. Defaults to `medium`. This can also be set directly from the UI. +**`colCount`** | `number` | _Optional_ | The number of columns of sections displayed on the homepage, using the default view. Should be in integer between `1` and `8`. Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable. **`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI) **`cssThemes`** | `string[]` | _Optional_ | An array of custom theme names which can be used in the theme switcher dropdown **`customColors`** | `object`| _Optional_ | Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See [Theming](/docs/theming.md#modifying-theme-colors) for more info diff --git a/src/utils/ConfigSchema.json b/src/utils/ConfigSchema.json index 9fdef5bb..b22a85f6 100644 --- a/src/utils/ConfigSchema.json +++ b/src/utils/ConfigSchema.json @@ -145,6 +145,12 @@ "default": "medium", "description": "The size of each link item / icon" }, + "colCount": { + "type": "number", + "minimum": 1, + "maximum": 8, + "description": "Number of section columns for homepage. Leave blank for column count to be responsively calculated based on screen size" + }, "hideComponents": { "type": "object", "description": "Hide individual parts of the page. If not set, all components are visible by default",