Global

Methods

extractContext(contextValue, checkboxValue, props) → {ExtractedContext}

Extracts checkbox group context information for a given checkbox value into a normal props object.
Parameters:
Name Type Description
contextValue Object The context information to extract.
checkboxValue CheckboxValue The value of the checkbox to extract context for.
props object Normal props to pass to the individual checkbox.
Source:
Returns:
Type
ExtractedContext

Type Definitions

CheckboxOptions

Type:
  • Object
Properties:
Name Type Attributes Description
checked boolean <nullable>
 Whether or not the checkbox is checked.
indeterminate boolean <nullable>
 Whether or not the checkbox is indeterminate.
onChange function <nullable>
 The function to call when the checkbox input changes state.
Source:

CheckboxValue

Type:
  • string | number | boolean
Source:

ExtractedContext

Type:
  • Object
Properties:
Name Type Description
name string The name of the checkbox group.
options CheckboxOptions The natural attributes of a checkbox input.
props * Any additional props to pass to a checkbox input.
Source: