Wiki
Clone wikipropable / Home
propable.propTypes
Object containing the prop types
Prop types:
propTypes.any
- Any prop typepropTypes.array
- Array prop typepropTypes.bool
- Boolean prop typepropTypes.color
- Color prop typepropTypes.date
- Date prop typepropTypes.func
- Function prop typepropTypes.label
- Label prop type (UI)propTypes.number
- Number prop typepropTypes.object
- Object prop typepropTypes.select
- Select prop type (UI)propTypes.spacer
- Spacer prop type (UI)propTypes.string
- String prop typepropTypes.trigger
- Trigger prop type
propable.list
Key/value map of all propTypes (useful for finding prop types by their type
string)
propable.extend(types)
Add additional prop types
Returns: Object<string, PropType>
- All prop types
Param | Type | Description |
---|---|---|
types | Object<string, PropType> |
Additional prop types |
propable.PropType
Class representing a property type
Construction
new PropType(type, parser, ui)
Create a prop type
Param | Type | Description |
---|---|---|
type | string |
The prop type id |
parser | function |
The prop type's parser: Returns parsed value or throws an error |
ui | Object |
The prop type's display settings |
Static methods
PropType.isPropType(maybePropType)
Check if the given value is a prop type
Param | Type | Description |
---|---|---|
maybePropType | * |
The value to check |
Members
type
The prop type id
ui
The prop type's display settings
parser
The prop type's parser function
Instance methods
pre(fn)
Register a pre-parser
Returns: PropType
- The prop type definition
Param | Type | Description |
---|---|---|
fn | function |
The parser function |
test(input)
Test if the given input can be converted to this prop type
Param | Type | Description |
---|---|---|
input | * |
The value to be tested |
parse(input)
Parse the given input
Param | Type | Description |
---|---|---|
input | * |
The value to be parsed |
register(obj)
Register the prop type in a prop type list
Returns: PropType
- The prop type definition
Param | Type | Description |
---|---|---|
obj | Object |
The object |
replace(obj)
Replace the prop type
Returns: PropType
- The prop type definition
Param | Type | Description |
---|---|---|
obj | PropType |
The replacement |
Updated