BridgeBeta
  • Brand
  • Digital Assets
    Foundations
    Icons
    Components
    Templates
  • Resources
    Design Tokens
    How-tos
    Best Practices
    Libraries
    Accessibility
    Products List
  • Support
    • Overview
    • Actions
      • Overview
      • Button
      • ContextMenu
      • Link
    • Controls
      • Overview
      • Checkbox
      • Tag
      • Toggle
    • Forms
      • Overview
      • DatePicker
      • FileUploader
      • Input
      • NumberInput
      • RadioButton
      • Search
      • Select
      • Slider
      • TextArea
      • TextInput
    • Hooks
      • useIsomorphicLayoutEffect
      • useMediaQuery
      • useSettings
    • Navigation
      • Overview
      • AnchorNavigation
      • BannerNavigation
      • Breadcrumb
      • Footer
      • InfoBar
      • MainNavigation
      • SecondaryNavigation
      • StepNavigation
      • SubNavigation
    • Overlay
      • Overview
      • Credits
      • Modal
      • ModalWrapper
      • Notification
      • Tooltip
    • Structure
      • Overview
      • Accordion
      • AuthLayout
      • Avatar
      • Callout
      • Card
      • ContentSwitcher
      • Empty
      • Hero
      • InlineLoading
      • Item
      • List
      • Loading
      • mdxComponents
      • Module
      • Pagination
      • ReadMore
      • Story
      • Table
      • Tabs
      • Text
      • Unit
      • User
      • WFPCoreProvider
      • Wrapper
Components
Controls
Checkbox

Checkbox

  • Design
  • Code
  • Props

Checkbox

Editable Example

import { Checkbox } from "@wfp/react";

() => {
  return <Checkbox labelText="Checkbox label text" />;
};

PropDefaultDescriptionValue

onChange

(event: ChangeEvent<HTMLInputElement>,checked?: boolean,customId?: string) => void
() => {}

@param event | The event triggering the change @param checked | The new value of the checkbox @param customId | The id of the checkbox

default: () => {}

indeterminate

boolean
–

Specify whether the Checkbox is in an indeterminate state

labelText

ReactNode
–

Provide a label to provide a description of the Checkbox input that you are exposing to the user

hideLabel

boolean
–

Specify whether the label should be hidden, or not

invalid

boolean
–

Invalid state for the checkbox

invalidText

string
–

Provide the text that is displayed when the checkbox is in an invalid state

wrapperClassName

string
–

The CSS class name to be placed on the wrapping element

On this page

  • Checkbox

References

  • Storybook
Storybook
Figma library
Contact us
2025 © World Food Programme