A next-generation tool to create blazing-fast documentation sites
API
created:12/30/2020
updated:12/30/2020
loc
5
comments
0

Boolean

@component-controls/core
3.14.6
import { BooleanControl } from '@component-controls/core';

Overview

A simple story that just returns "YES" or "NO"

YES
Name
Description
Default
Controls
bool

a boolean control

boolean
true
Name
Description
Default
type
ControlTypes.BOOLEAN
-
label

label to display next to the field editor by default uses the property name itself

string
-
value

a default value for the property

boolean
-
defaultValue

default value is automatically set at run-time, from the value

boolean
-
required

visually display the control property as required

boolean
-
description

full text property description. can use markdown.

string
-
hidden

hide the property editor for this property will only use the value

boolean
-
groupId

allows grouping of the properties in a property editor for example different editor tabs

string
-
order

allows custom sorting of the properties if 'order' is not provided, the props will be sorted by the order/key of the object (unreliable)

number
-
data

helper information to generate random data will be used in conjunction with faker.js data can be set to false, if the control should not be randomized

falseComponentControlDatanull
-

Commits

Date
Author
Commit Message
6/16/2020

atanasster

avatar of atanasster
chore: merge specification into core package
1 commits
file
imports
"../../controls"
ComponentControlBoolean
"./types"
AsReactComponent