@cavilha/chip
Version:
A component that allow users to make selections and filter content.
68 lines (67 loc) • 1.7 kB
TypeScript
import React from 'react';
import * as S from './Chip.styles';
export declare type ChipItemProps = {
/**
* Texto do chip
*/
label: string;
/**
* Define se o chip está desabilitado ou não
*/
isDisabled?: boolean;
/**
* Id unica para o chip
*/
id: string;
} & S.ChipItemProps;
/**
* A Chip component
*
*
*
* ### Usage
*
* <p></p>
*
*
*/
export declare const ChipItem: ({ id, label, value, isDisabled, css, ...props }: ChipItemProps) => JSX.Element;
export declare type ChipGroupProps = {
/**
* Tipo de componente que podem ser utilizados dentro de um grupo de chips
*/
children?: React.ReactElement<ChipItemProps>[] | React.ReactElement<ChipItemProps>;
/**
* Define se todos os chips do grupo devem ser desabilitados ou não
*/
isDisabled?: boolean;
/**
* Define se o tipo de seleção deve ser uníca ou multipla
*/
type?: 'single' | 'multiple';
/**
* Define se o tipo de seleção deve ser uníca ou multipla
*/
onChange?: (value: string[] | string) => void;
/**
* Em conjunto com rovingFocus, caso habiltada permite o loop entre os chips dentro do grupo através das setas do teclado
*/
loop?: boolean;
/**
* Habilita/Desabilita a navegação via setas do teclado dentro do grupo de chips
*/
rovingFocus?: boolean;
} & S.ChipGroupProps;
/**
* A Chip Group component
*
*
*
* ### Usage
*
* <p></p>
*
*
*/
declare const Chips: ({ isDisabled, children, onChange, loop, rovingFocus, css, ...props }: ChipGroupProps) => JSX.Element;
export default Chips;