npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tdcerhverv/checkbox

v1.4.1

Published

Checkbox component

Downloads

9

Readme

Checkbox component

Usage

Import like this:

import { Checkbox } from '@tdcerhverv/checkbox';

Checkbox is a controlled input component that handles checked state internally or by supplied props. It wraps around the CheckboxUncontrolled components.

import { CheckboxSimple } from '@tdcerhverv/checkbox';

CheckboxSimple is wrapping the normal Checkbox with legacy support.

Note: The simple variant is kept for compatibility reasons, and will be removed in next major version (^2.0.0).

import { CheckboxUncontrolled } from '@tdcerhverv/checkbox';

CheckboxUncontrolled is the core component that renders the required html elements and applies styling. Checkbox is a wrapper around this.

import { CheckboxGroup } from '@tdcerhverv/checkbox';

CheckboxGroup accepts an array of ICheckboxItem (see below) and displays them all with a breakpoint in between.

import { findAndSwitch } from '@tdcerhverv/checkbox';

findAndSwitch is a helper function to be used with CheckboxGroup that finds an entry in the array of ICheckboxItem and toggles the checked state and removes any error. It returns a new array with a clone of the mutated item.

Props & Types

These are all quite similar but with minor differences anyway. They are explained individually here for clarity reasons.

Checkbox

The standard Checkbox extends React HTMLInputElement type, but omits certain props. Here's a simplified version:

interface ICheckbox extends HTMLInputElement {
  error?: string;
  label?: ReactNode;
  labelClassName?: string;
  errorClassName?: string;
  indeterminate?: boolean;
  isChecked?: boolean;
}

These are the props of the HTMLInputElement type that are omitted and therefore not supported:

  checked?: boolean;
  type?: string;

CheckboxUncontrolled

The uncontrolled variant extends the React HTMLInputElement type, but is less restricted and only omits type prop.

interface ICheckboxUncontrolled extends HTMLInputElement {
  error?: string;
  label?: ReactNode;
  labelClassName?: string;
  errorClassName?: string;
  indeterminate?: boolean;
}

This is the prop of the HTMLInputElement type that is omitted and therefore not supported:

  type?: string;

CheckboxSimple

Note: The simple variant is kept for compatibility reasons, and will be removed in next major version (^2.0.0).

Like the the standard Checkbox it extends React HTMLInputElement type, but omits certain props. Here's a simplified version:

interface CheckboxRenderProps extends HTMLInputElement {
  error?: string;
  label?: ReactNode;
  labelClassName?: string;
  errorClassName?: string;
  indeterminate?: boolean;
  isChecked?: boolean;
  state?: 'checked' | 'unchecked';
}

These are the props of the HTMLInputElement type that are omitted and therefore not supported:

  checked?: boolean;
  type?: string;

As listed the CheckboxSimple also support the new isChecked boolean property.

CheckboxGroup

The group component creates a <fieldset> with Checkbox components. It accepts either Checkbox or CheckboxSimple interfaces, but renders only Checkbox.

type ICheckboxItem = ICheckbox | CheckboxRenderProps;

interface ICheckboxGroup {
  items: ICheckboxItem[];
  onItemChange: (item: ICheckboxItem) => void;
  legend?: string;
  indent?: boolean;
}

Adding legend will place a title above the checkboxes, and indent will push the checkboxes like a nested group.

See the examples folder for examples on usage with findAndSwitch.

Note: support for CheckboxSimple interface will be removed in next major version (^2.0.0).

Uncontrolled variant

The default checkbox is controlled, and that's the one you are supposed to use. However, it is possibly to use the uncontrolled variant.

import { CheckboxUncontrolled } from '@tdcerhverv/checkbox';

CheckboxUncontrolled is an input type=checkbox component with applied TDC Erhverv specific styling. The difference between CheckboxUncontrolled and Checkbox is that the later can be given a specific state value ("checked | unchecked") and an onChange function, while the uncontrolled handles checked state in the DOM, and you will have to use a ref to get the checked state.

Read more here (learn why it's a separate compononent):

Note: the uncontrolled variant will be less exposed in next major version (^2.0.0), so that if you really need it you will have to import it from the full path, @tdcerhverv/checkbox/lib/variants/CheckboxUncontrolled.

Known Issues & To-Do

  • Remove legacy support for CheckboxSimple in next major version (^2.0.0).
  • Remove uncontrolled variant from default exports.

Tags

input checkbox