@highoutput/hds-checkbox-group v0.3.1

Getting started

We aim to build a library of custom ReactJS components that implements our unique UI design conventions. The ReactJS components will be based primarily on Chakra UI components. React Storybook will be used for documentation and testing.

Commands

To install the package, use:

npm i @highoutput/hds-radio-group

Usage

import * as React from "react";
import { CheckboxGroup } from "@highoutput/hds-checkbox-group";
import { ThemeProvider, HStack, Box, Text } from "@highoutput/hds";
import DollarIcon from "./DollarIcon";

const users = [
  { id: 1, name: "Mary", salary: 1500 },
  { id: 1, name: "Will", salary: 2000 },
  { id: 1, name: "Sean", salary: 2500 },
];

export default function Example() {
  const [value, setValue] = React.useState<typeof users>([]);

  return (
    <ThemeProvider theme={extendTheme(withCheckboxGroup())}>
      <CheckboxGroup
        size="lg"
        variant="dot"
        items={users}
        value={value}
        onChange={setValue}
        compareFn={(user) => user.id}
      >
        {({ item, index, getProps }) => {
          const { container, icon, radio } = getProps(/* { disabled: true } */);

          return (
            <HStack key={item.id} spacing={4} {...container}>
              <Box {...icon}>
                <Icon as={DollarIcon} />
              </Box>

              <Box flexGrow={1}>
                <Text>{item.name}</Text>
                <Text>{item.salary}</Text>
              </Box>

              <Box {...radio} />
            </HStack>
          );
        }}
      </CheckboxGroup>
    </ThemeProvider>
  );
}