Skip to content

Commit 18bad4e

Browse files
lsmarsdenlsmarsden
committed
Add sub button wheel v1.0.0
1 parent 42a0edd commit 18bad4e

File tree

13 files changed

+1348
-595
lines changed

13 files changed

+1348
-595
lines changed

‎modules/sub_button_wheel/CONFIG_OPTIONS.md‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
# `sub_button_wheel`
2+
3+
- [1. Property `wheel_opener`](#1-property-wheel_opener)
4+
- [2. Property `layout_options`](#2-property-layout_options)
5+
- [2.1. Property `wheel_layout`](#21-property-wheel_layout)
6+
- [2.2. Property `double_ring_inner_count`](#22-property-double_ring_inner_count)
7+
- [3. Property `animation_options`](#3-property-animation_options)
8+
- [3.1. Property `wheel_animation`](#31-property-wheel_animation)
9+
- [3.2. Property `animation_delay`](#32-property-animation_delay)
10+
- [3.3. Property `animation_duration`](#33-property-animation_duration)
11+
- [4. Property `wheel_buttons`](#4-property-wheel_buttons)
12+
- [4.1. wheel_button](#41-wheel_button)
13+
- [4.1.1. Property `sub_button`](#411-property-sub_button)
14+
- [4.1.2. Property `position`](#412-property-position)
15+
16+
**Title:** `sub_button_wheel`
17+
18+
| **Type** | **Default** | **Description** |
19+
| -------- | ----------- | ------------------------------------------------------- |
20+
| object | - | Configuration for sub-button wheel layout functionality |
21+
22+
**Description:** Configuration for sub-button wheel layout functionality
23+
24+
| Property | Type | Default | Description |
25+
| ----------------------------------------- | ------ | ------- | ---------------------------------------------------------------- |
26+
| + wheel_opener | string | - | Button that opens the wheel (e.g., 'main', 'sub-button-1', etc.) |
27+
| - [layout_options](#layout_options) | object | - | Layout configuration options |
28+
| - [animation_options](#animation_options) | object | - | Animation configuration options |
29+
| + wheel_buttons | array | - | Array of sub-buttons to include in the wheel |
30+
31+
## 1. Property `wheel_opener`
32+
33+
| **Type** | **Default** | **Description** |
34+
| -------- | ----------- | ---------------------------------------------------------------- |
35+
| string | - | Button that opens the wheel (e.g., 'main', 'sub-button-1', etc.) |
36+
37+
**Description:** Button that opens the wheel (e.g., 'main', 'sub-button-1', etc.)
38+
39+
## 2. Property `layout_options`
40+
41+
| **Type** | **Default** | **Description** |
42+
| -------- | ----------- | ---------------------------- |
43+
| object | - | Layout configuration options |
44+
45+
**Description:** Layout configuration options
46+
47+
| Property | Type | Default | Description |
48+
| -------------------------------------------------------------------- | ---------------- | ------------- | --------------------------------------------------------- |
49+
| - [wheel_layout](#layout_options_wheel_layout) | enum (of string) | "even-circle" | Wheel layout style |
50+
| - [double_ring_inner_count](#layout_options_double_ring_inner_count) | integer | 4 | Number of buttons in inner ring (double-ring layout only) |
51+
52+
### 2.1. Property `wheel_layout`
53+
54+
| **Type** | **Default** | **Description** |
55+
| ---------------- | ------------- | ------------------ |
56+
| enum (of string) | "even-circle" | Wheel layout style |
57+
58+
**Description:** Wheel layout style
59+
60+
Must be one of:
61+
62+
- "even-circle"
63+
- "progressive-arc"
64+
- "compact-arc"
65+
- "fixed-position"
66+
- "double-ring"
67+
- "smart-adaptive"
68+
69+
### 2.2. Property `double_ring_inner_count`
70+
71+
| **Type** | **Default** | **Description** |
72+
| -------- | ----------- | --------------------------------------------------------- |
73+
| integer | 4 | Number of buttons in inner ring (double-ring layout only) |
74+
75+
**Description:** Number of buttons in inner ring (double-ring layout only)
76+
77+
| Restrictions | |
78+
| ------------ | ------ |
79+
| **Minimum** | ≥ 1 |
80+
| **Maximum** | ≤ 8 |
81+
82+
## 3. Property `animation_options`
83+
84+
| **Type** | **Default** | **Description** |
85+
| -------- | ----------- | ------------------------------- |
86+
| object | - | Animation configuration options |
87+
88+
**Description:** Animation configuration options
89+
90+
| Property | Type | Default | Description |
91+
| ------------------------------------------------------------- | ---------------- | ----------------- | ----------------------------------------------- |
92+
| - [wheel_animation](#animation_options_wheel_animation) | enum (of string) | "staggered-scale" | Animation style when wheel opens |
93+
| - [animation_delay](#animation_options_animation_delay) | number | 0.5 | Initial delay before animation starts (seconds) |
94+
| - [animation_duration](#animation_options_animation_duration) | number | 1.0 | Total duration of animation (seconds) |
95+
96+
### 3.1. Property `wheel_animation`
97+
98+
| **Type** | **Default** | **Description** |
99+
| ---------------- | ----------------- | -------------------------------- |
100+
| enum (of string) | "staggered-scale" | Animation style when wheel opens |
101+
102+
**Description:** Animation style when wheel opens
103+
104+
Must be one of:
105+
106+
- "staggered-scale"
107+
- "instant"
108+
109+
### 3.2. Property `animation_delay`
110+
111+
| **Type** | **Default** | **Description** |
112+
| -------- | ----------- | ----------------------------------------------- |
113+
| number | 0.5 | Initial delay before animation starts (seconds) |
114+
115+
**Description:** Initial delay before animation starts (seconds)
116+
117+
| Restrictions | |
118+
| ------------ | ------- |
119+
| **Minimum** | ≥ 0 |
120+
| **Maximum** | ≤ 10 |
121+
122+
### 3.3. Property `animation_duration`
123+
124+
| **Type** | **Default** | **Description** |
125+
| -------- | ----------- | ------------------------------------- |
126+
| number | 1.0 | Total duration of animation (seconds) |
127+
128+
**Description:** Total duration of animation (seconds)
129+
130+
| Restrictions | |
131+
| ------------ | ------- |
132+
| **Minimum** | N/A |
133+
| **Maximum** | ≤ 10 |
134+
135+
## 4. Property `wheel_buttons`
136+
137+
| **Type** | **Default** | **Description** |
138+
| -------- | ----------- | -------------------------------------------- |
139+
| array | - | Array of sub-buttons to include in the wheel |
140+
141+
**Description:** Array of sub-buttons to include in the wheel
142+
143+
| | Array restrictions |
144+
| -------------------- | ------------------ |
145+
| **Min items** | N/A |
146+
| **Max items** | 8 |
147+
| **Items unicity** | False |
148+
| **Additional items** | False |
149+
| **Tuple validation** | See below |
150+
151+
| Each item of this array must be | Description |
152+
| ------------------------------------ | ----------- |
153+
| [wheel_button](#wheel_buttons_items) | - |
154+
155+
### 4.1. wheel_button
156+
157+
| **Type** | **Default** | **Description** |
158+
| -------- | ----------- | --------------- |
159+
| object | - | - |
160+
161+
| Property | Type | Default | Description |
162+
| ------------------------------------------- | ------- | ------- | --------------------------------------- |
163+
| + sub_button | string | - | Sub-button identifier (1, 2, 3, etc.) |
164+
| - [position](#wheel_buttons_items_position) | integer | - | Fixed position in wheel (1-8, optional) |
165+
166+
#### 4.1.1. Property `sub_button`
167+
168+
| **Type** | **Default** | **Description** |
169+
| -------- | ----------- | ------------------------------------- |
170+
| string | - | Sub-button identifier (1, 2, 3, etc.) |
171+
172+
**Description:** Sub-button identifier (1, 2, 3, etc.)
173+
174+
#### 4.1.2. Property `position`
175+
176+
| **Type** | **Default** | **Description** |
177+
| -------- | ----------- | --------------------------------------- |
178+
| integer | - | Fixed position in wheel (1-8, optional) |
179+
180+
**Description:** Fixed position in wheel (1-8, optional)
181+
182+
| Restrictions | |
183+
| ------------ | ------ |
184+
| **Minimum** | ≥ 1 |
185+
| **Maximum** | ≤ 8 |
186+
187+
---
188+
189+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans)

0 commit comments

Comments
 (0)