@free-dom/react-components 2.0.0

package/dist/types/components/NavigationMenu/NavigationMenuLink.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+type NavigationMenuLinkProps = {
+    /**
+     * Especifica qual o local para onde será navegado
+     */
+    href: string;
+    /**
+     * Renderiza um componente filho que servirá como componente
+     * de navegação. Se não for passado nenhum elemento, apenas
+     * um texto simples, o componente renderizado será uma `<a></a>`.
+     * Se for preciso usar um componente customizado de roteamento,
+     * ele deve ser passado como children.
+     */
+    children: React.ReactNode;
+    /**
+     * Especifica se o link deve estar desabilitado.
+     */
+    disabled?: boolean;
+    /**
+     * Especifica se o link está ativo. Útil para indicar
+     * a página atual para o usuário.
+     */
+    active?: boolean;
+    /**
+     * Evento disparado ao clicar no link
+     */
+    onSelect?: (event: Event) => void;
+    renderComponent?: (props: {
+        href: string;
+        children?: React.ReactNode;
+    }) => JSX.Element;
+};
+export declare function NavigationMenuLink({ children, href, disabled, active, onSelect, renderComponent, }: NavigationMenuLinkProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/NavigationMenu/index.d.ts

@@ -0,0 +1 @@
+export { NavigationMenu } from './NavigationMenu';

package/dist/types/components/NeedPermission/NeedPermission.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+type NeedPermissionProps = {
+    /**
+     * Define se o componente estará no estado de desabilitado ou não.
+     * Caso esteja desabilitado, irá renderizar um Tooltip com mensagem
+     * informando que o usuário não tem permissão para acessar o componente.
+     */
+    allowed?: boolean;
+    /**
+     * Componente filho que estará no estado de desabilitado caso o usuário
+     * não tenha permissão.
+     */
+    children: React.ReactElement;
+    /**
+     * Determina se o componente está no estado de loading ou não. Caso esteja
+     * no estado de loading, renderiza o fallback especificado na prop `fallback`.
+     */
+    loading?: boolean;
+    /**
+     * Componente React renderizado como fallback. Útil para mostrar estado
+     * de loading enquanto é feita consulta à API para saber se o usuário
+     * tem as devidas ppermissões
+     */
+    fallback?: React.ReactNode;
+};
+export declare function NeedPermission({ children, loading, allowed, fallback, }: NeedPermissionProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/NeedPermission/index.d.ts

@@ -0,0 +1 @@
+export { NeedPermission } from './NeedPermission';

package/dist/types/components/PasswordInput/ClearButton.d.ts

@@ -0,0 +1,8 @@
+type ClearButtonProps = {
+    onClick?: React.MouseEventHandler<HTMLButtonElement>;
+    visible: boolean;
+    disabled?: boolean;
+    readOnly?: boolean;
+};
+export declare function ClearButton({ onClick, visible, disabled, readOnly, }: ClearButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PasswordInput/InputHelpers.d.ts

@@ -0,0 +1,7 @@
+type InputHelpersProps = {
+    maxLength?: number;
+    textCount?: number;
+    children?: React.ReactNode;
+};
+export declare function InputHelpers({ maxLength, textCount, children, }: InputHelpersProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PasswordInput/PasswordInput.constants.d.ts

@@ -0,0 +1 @@
+export declare const POSITIVE_NUMBERS_THRESHOLD = 0;

package/dist/types/components/PasswordInput/PasswordInput.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { Combine } from '../../utils';
+type PasswordInputOwnProps = {
+    /**
+    * Label que será renderizada acima do input. Por motivos
+    * de acessibilidade deve
+    ser utilizado em conjunto com a prop `id` ou `name`.
+    */
+    label?: string;
+    /**
+     * Renderiza um input com aparência de erro e mensagem logo abaixo do input.
+     * Se utilizada com a prop `hint`, a prop `error` terá prioridade e
+     * irá sobrescrever a mensagem de `hint`.
+     */
+    error?: string;
+    /**
+     * Renderiza uma mensagem de informação logo abaixo do input.
+     * Se utilizada com a prop `error`, a prop `error` terá prioridade e
+     * irá sobrescrever a mensagem de `hint`.
+     */
+    hint?: string;
+};
+type PasswordInputProps = Combine<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, PasswordInputOwnProps>;
+export declare function PasswordInputWithFowardedRef({ label, className, hint, onChange, defaultValue, error, style, value: valueProps, id, name, maxLength, ...rest }: PasswordInputProps, forwardedRef: React.ForwardedRef<HTMLInputElement>): import("react/jsx-runtime").JSX.Element;
+export declare const PasswordInput: React.ForwardRefExoticComponent<Omit<PasswordInputProps, "ref"> & React.RefAttributes<HTMLInputElement>>;
+export {};

package/dist/types/components/PasswordInput/ToggleVisibility.d.ts

@@ -0,0 +1,7 @@
+type ToggleVisibilityProps = {
+    isVisible?: boolean;
+    onClick?: () => void;
+    disabled?: boolean;
+};
+export declare function ToggleVisibility({ isVisible, ...buttonProps }: ToggleVisibilityProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PasswordInput/index.d.ts

@@ -0,0 +1 @@
+export { PasswordInput } from './PasswordInput';

package/dist/types/components/PieChart/CustomPieLegend.d.ts

@@ -0,0 +1,13 @@
+type CustomPieLegendProps<T> = {
+    payload?: {
+        color: string;
+        value: number;
+        dataKey: string;
+        payload: T & {
+            percent: number;
+        };
+    }[];
+    categoryKey: string;
+};
+export declare function CustomPieLegend<T>({ payload, categoryKey, }: CustomPieLegendProps<T>): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PieChart/PieChart.constants.d.ts

@@ -0,0 +1 @@
+export declare const CSS_PREFIX = "freedom-pie-chart";

package/dist/types/components/PieChart/PieChart.d.ts

@@ -0,0 +1,102 @@
+import { PropsWithChildren, ReactNode } from 'react';
+export type TooltipInfo<T> = {
+    title?: string;
+    description?: string;
+    customContent?: never;
+} | {
+    title?: never;
+    description?: never;
+    customContent: (props: T) => JSX.Element;
+};
+export type PieChartProps<T> = {
+    /**
+     * Título principal exibido no topo do gráfico.
+     */
+    title: string;
+    /**
+     * Subtítulo opcional exibido abaixo do título principal, fornecendo informações adicionais.
+     */
+    subtitle?: string;
+    /**
+     * Define a orientação do gráfico. Aceita os valores 'vertical' ou 'horizontal'.
+     * Determina a disposição dos elementos visuais.
+     */
+    orientation?: 'vertical' | 'horizontal';
+    /**
+     * Array contendo os dados utilizados para construir o gráfico.
+     * Cada elemento do array representa um conjunto de informações.
+     */
+    data: T[];
+    /**
+     * Conteúdo personalizado para exibição em um modal de descrição detalhada.
+     * Aceita componentes React, permitindo total flexibilidade de layout e estilo.
+     */
+    descriptionContent?: ReactNode;
+    /**
+     * Altura do gráfico em pixels. Define o espaço vertical ocupado pelo componente.
+     */
+    height?: number;
+    /**
+     * Indica se o gráfico está em estado de carregamento.
+     * Pode ser usado para exibir um indicador de progresso enquanto os dados são processados.
+     */
+    loading?: boolean;
+    /**
+     * Função de callback acionada ao selecionar a opção de "Atualizar dados".
+     * Permite recarregar ou recalcular os dados exibidos no gráfico.
+     */
+    onUpdateData?: () => void;
+    /**
+     * Configuração personalizada para o Tooltip exibido ao interagir com o gráfico.
+     * Aceita informações detalhadas, incluindo componentes React para maior personalização.
+     */
+    tooltipContent?: TooltipInfo<T>;
+    /**
+     * Habilita ou desabilita a exibição de uma descrição detalhada do gráfico.
+     */
+    enableDescription?: boolean;
+    /**
+     * Determina se a funcionalidade de filtragem de dados está ativa no gráfico.
+     * @default true
+     */
+    enableFilter?: boolean;
+    /**
+     * Controla a exibição da opção de atualizar os dados do gráfico.
+     * @default true
+     */
+    enableUpdateData?: boolean;
+    /**
+     * Especifica a chave de um item no array `data` usada para identificar
+     * categorias no gráfico, como rótulos de legenda ou eixos.
+     */
+    categoryKey: keyof T;
+    /**
+     * Especifica a chave de um item no array `data` usada para identificar
+     * os valores associados às categorias no gráfico.
+     */
+    valueKey: keyof T;
+    /**
+     * Referência ao elemento HTML que será o container do menu dropdown gerado.
+     * @default document.body
+     */
+    containerRef?: React.RefObject<HTMLElement>;
+    /**
+     * Paleta de cores usada no gráfico. Pode ser o esquema padrão ou monocromático.
+     * @default 'default'
+     */
+    palette?: 'default' | 'monochromatic';
+    /**
+     * Objeto de estilo inline para personalização do estilo do componente.
+     */
+    style?: React.CSSProperties;
+    /**
+     * Função para aplicar formatação personalizada aos valores exibidos no gráfico.
+     * Pode ser usada para alterar a aparência ou formato dos números.
+     */
+    valueFormatter?: (value: number) => any;
+    /**
+     * Cores customizadas para cada barra do gráfico
+     */
+    customColors?: Partial<Record<string, string>>;
+};
+export declare function PieChart<T>({ title, subtitle, orientation, data: dataProp, descriptionContent, style, height, onUpdateData, tooltipContent, categoryKey, valueKey, loading, enableDescription, enableFilter, enableUpdateData, containerRef, children, palette, valueFormatter, customColors, }: PropsWithChildren<PieChartProps<T>>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/PieChart/PieChart.helpers.d.ts

@@ -0,0 +1,15 @@
+export declare function getLegendConfig(orientation: 'vertical' | 'horizontal'): {
+    legendAlign: string;
+    legendVerticalAlign: string;
+    legendMaxHeight: string;
+    legendWidth: string;
+    legendRight: string;
+    legendBottom: any;
+} | {
+    legendAlign: string;
+    legendVerticalAlign: string;
+    legendMaxHeight: string;
+    legendWidth: string;
+    legendRight: any;
+    legendBottom: string;
+};

package/dist/types/components/PieChart/PieChartGraphic.d.ts

@@ -0,0 +1,12 @@
+import type { TooltipInfo } from './PieChart';
+export type PieChartGraphicProps<T> = {
+    orientation?: 'vertical' | 'horizontal';
+    data: T[];
+    tooltipContent?: TooltipInfo<T>;
+    categoryKey: keyof T;
+    valueKey: keyof T;
+    palette: 'default' | 'monochromatic';
+    valueFormatter: (value: number) => any;
+    customColors?: Partial<Record<string, string>>;
+};
+export declare function PieChartGraphic<T>({ orientation, data, tooltipContent, categoryKey, valueKey, palette, valueFormatter, customColors, }: PieChartGraphicProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/PieChart/PieChartSkeleton.d.ts

@@ -0,0 +1,8 @@
+type PieChartProps = {
+    width?: number;
+    height?: number;
+    orientation?: 'horizontal' | 'vertical';
+    style?: React.CSSProperties;
+};
+export declare function PieChartSkeleton({ style, width, height, orientation, }: PieChartProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PieChart/TooltipChart.d.ts

@@ -0,0 +1,11 @@
+import { TooltipProps } from 'recharts/types/component/Tooltip';
+import { NameType, ValueType } from 'recharts/types/component/DefaultTooltipContent';
+import type { TooltipInfo } from './PieChart';
+type TooltipProp<T> = TooltipProps<ValueType, NameType> & {
+    categoryKey: keyof T;
+    valueKey: keyof T;
+    tooltipContent?: TooltipInfo<T>;
+    valueFormatter: (value: number) => any;
+};
+export declare function TooltipChart<T>({ tooltipContent, categoryKey, valueKey, valueFormatter, ...rest }: TooltipProp<T>): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/PieChart/index.d.ts

@@ -0,0 +1 @@
+export { PieChart } from './PieChart';

package/dist/types/components/ProgressBar/ProgressBar.d.ts

@@ -0,0 +1,11 @@
+export type ProgressBarProps = {
+    /**
+     * Valor do progresso
+     */
+    progress: number;
+    /**
+     * Mostra com indicadores de cores o progresso
+     */
+    color?: boolean;
+};
+export declare function ProgressBar({ progress: progressProps, color, children, }: React.PropsWithChildren<ProgressBarProps>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/ProgressBar/ProgressBar.helpers.d.ts

@@ -0,0 +1 @@
+export declare function progressValueSanitizer(progress: number): number;

package/dist/types/components/ProgressBar/index.d.ts

@@ -0,0 +1 @@
+export { ProgressBar } from './ProgressBar';

package/dist/types/components/RadioGroup/Item.d.ts

@@ -0,0 +1,21 @@
+import { PropsWithChildren } from 'react';
+type ItemProps = {
+    /**
+     * Id único que identifica o switch.
+     */
+    id?: string;
+    /**
+     * Especifica o valor que o switch deve ter.
+     */
+    value: string;
+    /**
+     * Texto que será renderizada ao lado do radio.
+     */
+    children: string;
+    /**
+     * Especifica se o componente deve estar desabilitado.
+     */
+    disabled?: boolean;
+};
+export declare function RadioGroupItem(props: PropsWithChildren<ItemProps>): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/RadioGroup/RadioGroup.d.ts

@@ -0,0 +1,33 @@
+import { RadioGroupItem } from './Item';
+export type RadioGroupProps = {
+    /**
+     * className customizada que será aplicado ao componente.
+     */
+    className?: string;
+    /**
+     * Especifica se o componente deve estar desabilitado.
+     */
+    disabled?: boolean;
+    /**
+     * Valor padrão com o qual o componente será renderizado.
+     */
+    defaultValue?: string;
+    /**
+     * Valor selecionado.
+     */
+    value?: string;
+    /**
+     * Executa função quando o radio é selecionado
+     */
+    onRadioChange?: (e: string) => void;
+    /**
+     * Especifica se o grupo deve ser renderizado em linha ao
+     * invés de coluna
+     */
+    row?: boolean;
+};
+declare function RadioGroup({ onRadioChange, value, ...rest }: React.PropsWithChildren<RadioGroupProps>): import("react/jsx-runtime").JSX.Element;
+declare namespace RadioGroup {
+    var Item: typeof RadioGroupItem;
+}
+export { RadioGroup };

package/dist/types/components/RadioGroup/index.d.ts

@@ -0,0 +1 @@
+export { RadioGroup } from './RadioGroup';

package/dist/types/components/Rating/NumericRating.d.ts

@@ -0,0 +1,17 @@
+export type NumericRatingValue = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+type NumericRatingProps = {
+    /**
+     * O valor padrão do rating.
+     */
+    defaultRating?: NumericRatingValue;
+    /**
+     * Função chamada quando o rating é alterado.
+     */
+    onChange?: (rating: NumericRatingValue) => void;
+    /**
+     * Se o rating é somente leitura.
+     */
+    readOnly?: boolean;
+};
+export declare function NumericRating({ defaultRating, onChange, readOnly, }: NumericRatingProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/Rating/Rating.constants.d.ts

@@ -0,0 +1,9 @@
+export declare enum SatisfactionRatingEnum {
+    EXTREMELY_DISSATISFIED = "extremely-dissatisfied",
+    DISSATISFIED = "dissatisfied",
+    NEUTRAL = "neutral",
+    SATISFIED = "satisfied",
+    VERY_SATISFIED = "very-satisfied"
+}
+export declare const MAX_STAR_RATING = 5;
+export declare const MAX_NUMERIC_RATING = 10;

package/dist/types/components/Rating/Rating.d.ts

@@ -0,0 +1,12 @@
+import { StarRatingProps } from './StarRating';
+import { SimpleRating } from './SimpleRating';
+import { SatisfactionRating } from './SatisfactionRating';
+import { NumericRating } from './NumericRating';
+type RatingProps = StarRatingProps;
+declare function Rating(props: RatingProps): import("react/jsx-runtime").JSX.Element;
+declare namespace Rating {
+    var Simple: typeof SimpleRating;
+    var Satisfaction: typeof SatisfactionRating;
+    var Numeric: typeof NumericRating;
+}
+export { Rating };

package/dist/types/components/Rating/Rating.helpers.d.ts

@@ -0,0 +1,4 @@
+import type { NumericRatingValue } from './NumericRating';
+import type { StarRatingValue } from './StarRating';
+export declare function getStarRatingArray(): StarRatingValue[];
+export declare function getNumericRatingArray(): NumericRatingValue[];

package/dist/types/components/Rating/SatisfactionRating.d.ts

@@ -0,0 +1,16 @@
+export type SatisfactionRatingValue = 'extremely-dissatisfied' | 'dissatisfied' | 'neutral' | 'satisfied' | 'very-satisfied';
+export type SatisfactionRatingProps = {
+    /**
+     * O valor padrão do rating.
+     */
+    defaultRating?: SatisfactionRatingValue;
+    /**
+     * Função chamada quando o rating é alterado.
+     */
+    onChange?: (rating: SatisfactionRatingValue) => void;
+    /**
+     * Se o rating é somente leitura.
+     */
+    readOnly?: boolean;
+};
+export declare function SatisfactionRating({ defaultRating, onChange, readOnly, }: SatisfactionRatingProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Rating/SimpleRating.d.ts

@@ -0,0 +1,17 @@
+type SimpleRatingValue = 'like' | 'dislike';
+type SimpleRatingProps = {
+    /**
+     * O valor padrão do rating.
+     */
+    defaultRating?: SimpleRatingValue;
+    /**
+     * Função chamada quando o rating é alterado.
+     */
+    onChange?: (rating: SimpleRatingValue) => void;
+    /**
+     * Se o rating é somente leitura.
+     */
+    readOnly?: boolean;
+};
+export declare function SimpleRating({ defaultRating, onChange, readOnly, }: SimpleRatingProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/Rating/StarRating.d.ts

@@ -0,0 +1,16 @@
+export type StarRatingValue = 1 | 2 | 3 | 4 | 5;
+export type StarRatingProps = {
+    /**
+     * O valor padrão do rating.
+     */
+    defaultRating?: StarRatingValue;
+    /**
+     * Função chamada quando o rating é alterado.
+     */
+    onChange?: (rating: StarRatingValue) => void;
+    /**
+     * Se o rating é somente leitura.
+     */
+    readOnly?: boolean;
+};
+export declare function StarRating({ defaultRating, onChange, readOnly, }: StarRatingProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Rating/index.d.ts

@@ -0,0 +1 @@
+export { Rating } from './Rating';

package/dist/types/components/Select/Checkbox.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Aqui não utilizamos o componente Checkbox já criado, pois durante a integração com o componente
+ * `Filter`, ao selecionar o Checkbox do Select, aconteciam erros de loop infinito que não conseguimos
+ * entender onde estava o problema de fato. Optamos pro criar um componente Checkbox apenas para ilustrar
+ * se a linha do select está selecionada ou não.
+ */
+type CheckboxProps = {
+    checked?: boolean | 'indeterminate';
+    disabled?: boolean;
+};
+export declare function Checkbox({ checked, disabled }: CheckboxProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/Select/ClearIndicator.d.ts

@@ -0,0 +1,3 @@
+import type { ClearIndicatorProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function ClearIndicator({ clearValue, selectProps, }: ClearIndicatorProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/Control.d.ts

@@ -0,0 +1,3 @@
+import type { ControlProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function Control(props: ControlProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/DropdownIndicator.d.ts

@@ -0,0 +1,3 @@
+import type { DropdownIndicatorProps } from 'react-select';
+import type { SelectOption, SelectGroupOption } from './Select';
+export declare function DropdownIndicator(props: DropdownIndicatorProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/GroupHeading.d.ts

@@ -0,0 +1,3 @@
+import type { GroupHeadingProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function GroupHeading(props: GroupHeadingProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/Menu.d.ts

@@ -0,0 +1,3 @@
+import { MenuProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function Menu(props: MenuProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/MenuList.d.ts

@@ -0,0 +1,3 @@
+import type { MenuListProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function MenuList(props: MenuListProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/MultiValue.d.ts

@@ -0,0 +1,3 @@
+import { MultiValueProps } from 'react-select';
+import type { SelectOption, SelectGroupOption } from './Select';
+export declare function MultiValue({ data, }: MultiValueProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/NoOptionsMessage.d.ts

@@ -0,0 +1,3 @@
+import { NoticeProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function NoOptionsMessage(props: NoticeProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/Option.d.ts

@@ -0,0 +1,3 @@
+import type { OptionProps } from 'react-select';
+import type { SelectOption, SelectGroupOption } from './Select';
+export declare function Option(props: OptionProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/Placeholder.d.ts

@@ -0,0 +1,3 @@
+import type { PlaceholderProps } from 'react-select';
+import type { SelectGroupOption, SelectOption } from './Select';
+export declare function Placeholder(props: PlaceholderProps<SelectOption, boolean, SelectGroupOption>): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Select/Select.constants.d.ts

@@ -0,0 +1,2 @@
+import type { SelectOption } from './Select';
+export declare const SELECT_ALL_OPTION: SelectOption;