Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@accessible/checkbox
Advanced tools
Changelog
Readme
npm i @accessible/checkbox
An accessible checkbox component for React. This library allows you to create your own a checkbox with your own styles while maintaining the ability to focus and update a checkbox input with the keyboard.
Check out the example on CodeSandbox
import {Checkbox, Checkmark} from '@accessible/checkbox'
const MyCheckbox = () => (
<label className='my-checkbox'>
<Checkbox name='my-field-name'>
<span className='my-checkbox'>
<Checkmark checkedClass='checked' uncheckedClass='unchecked'>
<span className='checkmark' />
</Checkmark>
</span>
</Checkbox>
Check me!
</label>
)
Creates a visually hidden checkbox input that is focusable and accessible via keyboard navigation.
All props passed to this component are applied to the <input>
. This also creates a context
provider enabling the other components in this library to access the checkbox's state
deep in the tree.
Prop | Type | Default | Required? | Description |
---|---|---|---|---|
checked | boolean | undefined | No | Makes the checkbox a controlled component which can no longer be updated with check , uncheck , and toggle controls. |
defaultChecked | boolean | undefined | No | Set this to true to make the checkbox checked by default. |
onChange | (checked: boolean) => any | undefined | No | Called each time the checked state changes. |
children | React.ReactNode | undefined | No | Your custom styled checkbox. |
A convenient component for conditionally adding class names and styles when the component is checked/unchecked.
Prop | Type | Default | Required? | Description |
---|---|---|---|---|
uncheckedClass | string | undefined | No | This class name will be applied to the child element when the checkbox is unchecked . |
checkedClass | string | undefined | No | This class name will be applied to the child element when the checkbox is checked . |
uncheckedStyle | React.CSSProperties | undefined | No | These styles will be applied to the child element when the checkbox is unchecked . |
checkedStyle | React.CSSProperties | undefined | No | These styles name will be applied to the child element when the checkbox is checked . |
children | React.ReactNode | undefined | Yes | The child you wish to render when the checkbox is checked. |
The child of this component will only render when the <Checkbox>
is in
a checked
state. It must be a child of a <Checkbox>
.
Prop | Type | Default | Required? | Description |
---|---|---|---|---|
children | React.ReactNode | undefined | Yes | The child you wish to render when the checkbox is checked. |
The child of this component will only render when the <Checkbox>
is in
an unchecked
state. It must be a child of a <Checkbox>
.
Prop | Type | Default | Required? | Description |
---|---|---|---|---|
children | React.ReactNode | undefined | Yes | The child you wish to render when the checkbox is unchecked. |
This component clones its child and adds an onClick
handler to toggle the <Checkbox>
between
checked
and unchecked
states. It must be a child of a <Checkbox>
.
Prop | Type | Default | Required? | Description |
---|---|---|---|---|
children | React.ReactNode | undefined | Yes | The child you wish to render when the checkbox is unchecked. |
A React hook that returns the CheckboxContextValue
for the nearest <Checkbox>
parent.
interface CheckboxContextValue {
// Does the checkbox have a `checked` property?
checked: boolean
// Is the checkbox currently focused?
focused: boolean
// Is the checkbox currently disabled?
disabled: boolean
// Checks the checkbox
check: () => void
// Unchecks the checkbox
uncheck: () => void
// Toggles the checkbox `checked` property
toggle: () => void
}
MIT
FAQs
🅰 An accessible and versatile checkbox component for React
The npm package @accessible/checkbox receives a total of 156 weekly downloads. As such, @accessible/checkbox popularity was classified as not popular.
We found that @accessible/checkbox demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.