Skip to content

Commit 4d1439f

Browse files
twlitetwlite
committed
chore: docgen
1 parent ac4e2c5 commit 4d1439f

11 files changed

Lines changed: 424 additions & 3 deletions

File tree

‎apps/website/docs/api-reference/commandkit/functions/checkbox-group-option.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "CheckboxGroupOption"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## CheckboxGroupOption
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="42" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
function CheckboxGroupOption(props: CheckboxGroupOptionProps): void
22+
```
23+
Parameters
24+
25+
### props
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/interfaces/checkbox-group-option-props#checkboxgroupoptionprops'>CheckboxGroupOptionProps</a>`} />
28+

‎apps/website/docs/api-reference/commandkit/functions/checkbox-group.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "CheckboxGroup"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## CheckboxGroup
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="71" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
function CheckboxGroup(props: CheckboxGroupProps): void
22+
```
23+
Parameters
24+
25+
### props
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/interfaces/checkbox-group-props#checkboxgroupprops'>CheckboxGroupProps</a>`} />
28+

‎apps/website/docs/api-reference/commandkit/functions/checkbox.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Checkbox"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## Checkbox
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="19" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
function Checkbox(props: CheckboxProps): void
22+
```
23+
Parameters
24+
25+
### props
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/interfaces/checkbox-props#checkboxprops'>CheckboxProps</a>`} />
28+

‎apps/website/docs/api-reference/commandkit/functions/radio-group-option.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "RadioGroupOption"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## RadioGroupOption
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/radio/radio.ts" sourceLine="54" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
function RadioGroupOption(props: RadioGroupOptionProps): void
22+
```
23+
Parameters
24+
25+
### props
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/interfaces/radio-group-option-props#radiogroupoptionprops'>RadioGroupOptionProps</a>`} />
28+

‎apps/website/docs/api-reference/commandkit/functions/radio-group.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "RadioGroup"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## RadioGroup
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/radio/radio.ts" sourceLine="19" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
function RadioGroup(props: RadioGroupProps): void
22+
```
23+
Parameters
24+
25+
### props
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/interfaces/radio-group-props#radiogroupprops'>RadioGroupProps</a>`} />
28+

‎apps/website/docs/api-reference/commandkit/interfaces/checkbox-group-option-props.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: "CheckboxGroupOptionProps"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## CheckboxGroupOptionProps
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="35" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
interface CheckboxGroupOptionProps {
22+
label: string;
23+
value: string;
24+
description?: string;
25+
default?: boolean;
26+
}
27+
```
28+
29+
<div className="members-wrapper">
30+
31+
### label
32+
33+
<MemberInfo kind="property" type={`string`} />
34+
35+
36+
### value
37+
38+
<MemberInfo kind="property" type={`string`} />
39+
40+
41+
### description
42+
43+
<MemberInfo kind="property" type={`string`} />
44+
45+
46+
### default
47+
48+
<MemberInfo kind="property" type={`boolean`} />
49+
50+
51+
52+
53+
</div>

‎apps/website/docs/api-reference/commandkit/interfaces/checkbox-group-props.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: "CheckboxGroupProps"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## CheckboxGroupProps
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="59" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
interface CheckboxGroupProps extends Omit<
22+
CheckboxGroupComponentData,
23+
'type' | 'options'
24+
> {
25+
id?: number;
26+
customId: string;
27+
children?: MaybeArray<CheckboxGroupOptionBuilder>;
28+
minValues?: number;
29+
maxValues?: number;
30+
required?: boolean;
31+
}
32+
```
33+
* Extends: <code>Omit&#60; CheckboxGroupComponentData, 'type' | 'options' &#62;</code>
34+
35+
36+
37+
<div className="members-wrapper">
38+
39+
### id
40+
41+
<MemberInfo kind="property" type={`number`} />
42+
43+
44+
### customId
45+
46+
<MemberInfo kind="property" type={`string`} />
47+
48+
49+
### children
50+
51+
<MemberInfo kind="property" type={`<a href='/docs/api-reference/commandkit/types/maybe-array#maybearray'>MaybeArray</a>&#60;CheckboxGroupOptionBuilder&#62;`} />
52+
53+
54+
### minValues
55+
56+
<MemberInfo kind="property" type={`number`} />
57+
58+
59+
### maxValues
60+
61+
<MemberInfo kind="property" type={`number`} />
62+
63+
64+
### required
65+
66+
<MemberInfo kind="property" type={`boolean`} />
67+
68+
69+
70+
71+
</div>

‎apps/website/docs/api-reference/commandkit/interfaces/checkbox-props.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "CheckboxProps"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## CheckboxProps
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/checkbox/checkbox.ts" sourceLine="11" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
interface CheckboxProps extends Omit<
22+
CheckboxComponentData,
23+
'type' | 'required'
24+
> {
25+
id?: number;
26+
default?: boolean;
27+
}
28+
```
29+
* Extends: <code>Omit&#60; CheckboxComponentData, 'type' | 'required' &#62;</code>
30+
31+
32+
33+
<div className="members-wrapper">
34+
35+
### id
36+
37+
<MemberInfo kind="property" type={`number`} />
38+
39+
40+
### default
41+
42+
<MemberInfo kind="property" type={`boolean`} />
43+
44+
45+
46+
47+
</div>

‎apps/website/docs/api-reference/commandkit/interfaces/radio-group-option-props.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: "RadioGroupOptionProps"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## RadioGroupOptionProps
15+
16+
<GenerationInfo sourceFile="packages/commandkit/src/components/interactive/radio/radio.ts" sourceLine="47" packageName="commandkit" />
17+
18+
19+
20+
```ts title="Signature"
21+
interface RadioGroupOptionProps {
22+
label: string;
23+
value: string;
24+
description?: string;
25+
default?: boolean;
26+
}
27+
```
28+
29+
<div className="members-wrapper">
30+
31+
### label
32+
33+
<MemberInfo kind="property" type={`string`} />
34+
35+
36+
### value
37+
38+
<MemberInfo kind="property" type={`string`} />
39+
40+
41+
### description
42+
43+
<MemberInfo kind="property" type={`string`} />
44+
45+
46+
### default
47+
48+
<MemberInfo kind="property" type={`boolean`} />
49+
50+
51+
52+
53+
</div>

0 commit comments

Comments
 (0)