Skip to content

Commit

Permalink
Fix array signature
Browse files Browse the repository at this point in the history
  • Loading branch information
@jsonmaf1a
jsonmaf1a committed Dec 19, 2024
1 parent d3dee66 commit 521de7e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 27 deletions.
10 changes: 5 additions & 5 deletions src/Configuration/Colors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ border = "#BEBEBEAA"
When defining gradients, use the same property as you would for a single color, but provide a table value instead.
All gradient configurations share these common properties:

| Key | Type | Default value | Short description |
| :----- | :-------- | :-----------: | :--------------------------------------- |
| mode | `String` | - | Specifies the gradient type |
| degree | `u16` | - | Angle of the gradient in degrees |
| colors | `Color[]` | - | An array of color values (in hex format) |
| Key | Type | Default value | Short description |
| :----- | :------------- | :-----------: | :--------------------------------------- |
| mode | `String` | - | Specifies the gradient type |
| degree | `u16` | - | Angle of the gradient in degrees |
| colors | `[Color; 2..]` | - | An array of color values (in hex format) |

### Supported gradient types

Expand Down
19 changes: 10 additions & 9 deletions src/Configuration/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,16 @@ Noti supports hot-reloading most configuration changes. Simply save your config

Before of all properties, need to understand a few primitive types. The complex types like array or table will be explained in place.

| Type | Description |
| ---------------------- | ------------------------------------------------- |
| `bool` | A boolean value |
| `u8` | An unsigned integer of 8 bit |
| `u16` | An unsigned integer of 16 bit |
| `String` | A string,typically used as an enumeration variant |
| `[..]` | Array containing various type. Used as tuple |
| [`Color`](./Colors.md) | A color value. Either string or table |
| `Path` | The path to particular file or directory |
| Type | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------- |
| `bool` | A boolean value |
| `u8` | An unsigned integer of 8 bit |
| `u16` | An unsigned integer of 16 bit |
| `String` | A string,typically used as an enumeration variant |
| `[...]` | An array containing various type. Used as tuple |
| `[T; from..to]` | An array with elements of type `T`, where the number of elements can vary between `from` and `to` (inclusive) |
| [`Color`](./Colors.md) | A color value. Either string or table |
| `Path` | The path to particular file or directory |

### Configuration Structure

Expand Down
26 changes: 13 additions & 13 deletions src/Configuration/Display.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

The `display` section allows you to customize the visual aspects of notifications.

| Property name | Description | Type | Default value |
| :---------------------------------- | :---------------------------------------------- | :---------------------------------------------------------------------- | :-----------: |
| [padding](#padding-margin) | Spacing from the banner's edge to inner content | `u8` or `[u8, u8]` or `[u8, u8, u8]` or `[u8, u8, u8, u8]` or `Spacing` | 0 |
| [margin](#padding-margin) | Spacing from the banner's edge to inner content | `u8` or `[u8, u8]` or `[u8, u8, u8]` or `[u8, u8, u8, u8]` or `Spacing` | 0 |
| [image](#image) | Image properties | `Image` | - |
| [border](#border) | Border properties | `Border` | - |
| [text](#text) | Text properties (alias for `title` and `body`) | `Text` | - |
| [title](#text) | Title text properties | `Text` | - |
| [body](#text) | Body text properties | `Text` | - |
| [markup](#markup) | Enables HTML markup | `bool` | true |
| [timeout](#timeout) | Banner timeout | `u16` or `Timeout` | 0 |
| [layout](../Layout/CustomLayout.md) | Custom layout path | `Path` | "default" |
| [theme](./themes) | Theme name | `String` | - |
| Property name | Description | Type | Default value |
| :---------------------------------- | :---------------------------------------------- | :-------------------------------- | :-----------: |
| [padding](#padding-margin) | Spacing from the banner's edge to inner content | `u8` or `[u8; 1..4]` or `Spacing` | 0 |
| [margin](#padding-margin) | Spacing from the banner's edge to inner content | `u8` or `[u8; 1..4]` or `Spacing` | 0 |
| [image](#image) | Image properties | `Image` | - |
| [border](#border) | Border properties | `Border` | - |
| [text](#text) | Text properties (alias for `title` and `body`) | `Text` | - |
| [title](#text) | Title text properties | `Text` | - |
| [body](#text) | Body text properties | `Text` | - |
| [markup](#markup) | Enables HTML markup | `bool` | true |
| [timeout](#timeout) | Banner timeout | `u16` or `Timeout` | 0 |
| [layout](../Layout/CustomLayout.md) | Custom layout path | `Path` | "default" |
| [theme](./themes) | Theme name | `String` | - |

## Padding & Margin

Expand Down

0 comments on commit 521de7e

Please sign in to comment.