FlorisBoard

https://docs.florisboard.org/
Admin
FlorisBoard is an open-source Android keyboard application that prioritizes user privacy and...
Tokens:3,018
Snippets:62
Trust Score:7.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Define extension.json metadata

Source: https://docs.florisboard.org/extensions

The mandatory root configuration file for all extensions, defining identity, versioning, and licensing.

```json
{
  "$": "ime.extension.<type>",
  "meta": {
    "id": "<my_extension_id>",
    "version": "<version_str>",
    "title": "...",
    "description": "...",
    "keywords": ["...", "...", ...],
    "maintainers": ["...", "...", ...],
    "license": "<license_id>"
  },
  ... extension type specific config ...
}
```

--------------------------------

### Configure theme extension metadata

Source: https://docs.florisboard.org/extensions

Additional configuration fields for theme extensions to define individual theme properties and Material You flags.

```json
{
  "themes": [
    {
      "id": "<theme_id>",
      "label": "...",
      "authors": [ ... ],
      "isNight": false,
      "materialYouFlags": {
        "paletteStyle": "Neutral",
        "contrastLevel": "Default",
        "specVersion": "SPEC_2021"
      }
    }
    ...
  ]
}
```

--------------------------------

### Margin and Padding Configuration

Source: https://docs.florisboard.org/themes/padding

Defines the structure and valid value formats for margin and padding properties.

```APIDOC
## Margin and Padding Properties

### Description
Controls the spacing of elements using density-independent pixels (dp). Applies to v0.5 or newer.

### Properties
- **margin** (Padding value) - Controls the margin of the element.
- **padding** (Padding value) - Controls the padding of the element.

### Padding Value Formats
- `<paddingStart>dp <paddingTop>dp <paddingEnd>dp <paddingBottom>dp`: Defines individual padding values (float >= 0).
- `<paddingHorizontal>dp <paddingVertical>dp`: Defines axis padding values (float >= 0).
- `<paddingAll>dp`: Defines all padding values (float >= 0).
```

--------------------------------

### Theme Color Properties

Source: https://docs.florisboard.org/themes/colors

Available properties for styling UI elements in FlorisBoard.

```APIDOC
## Element Color Properties

### Description
Properties used to control the appearance of UI elements.

### Properties
- **background**: Controls the background color of the element.
- **foreground**: Controls the foreground color of the element.
- **border-color**: Controls the border color of the element.
- **shadow-color**: Controls the shadow color of the element.

### Possible Values
- Static color
- Dynamic light color
- Dynamic dark color
```

--------------------------------

### Color Value Definitions

Source: https://docs.florisboard.org/themes/colors

Syntax and formats for defining static and dynamic colors in FlorisBoard stylesheets.

```APIDOC
## Static Color Definitions

### Description
Defines fixed color values using various formats.

### Formats
- **transparent**: Defines a transparent background.
- **rgb(<r>,<g>,<b>)**: RGB color (0-255).
- **rgba(<r>,<g>,<b>,<a>)**: RGBA color (r,g,b: 0-255; a: 0.0-1.0).
- **hex#<r><g><b>**: Hex color (00-FF).
- **hex#<r><g><b><a>**: Hex color with alpha (00-FF).

## Dynamic (Material You) Color Definitions

### Description
Defines colors derived from the system Material You color scheme or custom accent overrides.

### Formats
- **dynamic-light-color(<name>)**: Defines a dynamic light color using a valid ColorPalette ID.
- **dynamic-dark-color(<name>)**: Defines a dynamic dark color using a valid ColorPalette ID.
```
Tokens:
Raw