Function Switch

Accessibility

  • A Switch should always have a visible, clickable label next to it.
  • Whenever the design allows it, use <Switch> together with <FormControlLabel> (see the story for details). It will take care of most accessiblity requirements for you.
  • If you do use a standalone <Switch>, you must provide a name for the switch using aria-label or aria-labelledby via inputProps!
  • Warning! Never place a <Switch> inside a <Button>, <ClickableCard>, <CardActionArea> or any other interactive container! It will break accessibility.
  • Switch(props, deprecatedLegacyContext?): ReactNode

  • Parameters

    Returns ReactNode

Properties

contextTypes? defaultProps? displayName? propTypes?

Properties

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<SwitchProps>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

OptionalpropTypes

propTypes?: WeakValidationMap<SwitchProps>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

Settings

Member Visibility

On This Page

Accessibility
Properties