@cnc-ti/layout-basic 5.0.0 → 6.0.0

package/dist/index.d.mts

@@ -1,24 +1,139 @@
-import * as class_variance_authority_dist_types from 'class-variance-authority/dist/types';
-import { VariantProps } from 'class-variance-authority';
-import React from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-
-declare const buttonVariants: (props?: ({
-    variant?: "default" | "confirm" | "create" | "secondary" | "danger" | null | undefined;
-    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
-    outline?: boolean | null | undefined;
-} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
-interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
-    asChild?: boolean;
-    isLoading?: boolean;
-}
-declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
-
-type HeaderProps = {
-    userName: string;
-    imageUrl?: string;
-    entityName?: string;
-};
-declare const Header: ({ userName, entityName }: HeaderProps) => react_jsx_runtime.JSX.Element;
-
-export { Button, type ButtonProps, Header, type HeaderProps, buttonVariants };
+import * as class_variance_authority_dist_types from 'class-variance-authority/dist/types';
+import { VariantProps } from 'class-variance-authority';
+import * as React$1 from 'react';
+import React__default, { PropsWithChildren, ReactNode, ReactElement, ComponentProps, SVGProps } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as DialogPrimitive from '@radix-ui/react-dialog';
+import * as Accordion from '@radix-ui/react-accordion';
+
+declare const buttonVariants: (props?: ({
+    variant?: "default" | "confirm" | "create" | "secondary" | "danger" | null | undefined;
+    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
+    outline?: boolean | null | undefined;
+} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
+interface ButtonProps extends React__default.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
+    asChild?: boolean;
+    isLoading?: boolean;
+}
+declare const Button: React__default.ForwardRefExoticComponent<ButtonProps & React__default.RefAttributes<HTMLButtonElement>>;
+
+type HeaderProps = {
+    userName: string;
+    imageUrl?: string;
+    entityName?: string;
+};
+declare const Header: ({ userName, entityName }: HeaderProps) => react_jsx_runtime.JSX.Element;
+
+type ModalProps = {
+    title?: string;
+    content?: React.ReactElement;
+    onClose?: any;
+    visibleModal?: boolean;
+};
+declare const Modal: ({ title, content, visibleModal, onClose, }: ModalProps) => react_jsx_runtime.JSX.Element;
+
+type ModalMudancaEnntidadeProps = {
+    title?: string;
+    onClose?: any;
+    visibleModal?: boolean;
+    SelectComponent?: any;
+    buttonAction: React__default.MouseEventHandler<HTMLButtonElement>;
+};
+declare const ModalMudancaEntidade: ({ title, onClose, visibleModal, SelectComponent, buttonAction, }: ModalMudancaEnntidadeProps) => react_jsx_runtime.JSX.Element;
+
+declare const Dialog: React$1.FC<DialogPrimitive.DialogProps>;
+declare const DialogTrigger: React$1.ForwardRefExoticComponent<DialogPrimitive.DialogTriggerProps & React$1.RefAttributes<HTMLButtonElement>>;
+declare const DialogPortal: React$1.FC<DialogPrimitive.DialogPortalProps>;
+declare const DialogClose: React$1.ForwardRefExoticComponent<DialogPrimitive.DialogCloseProps & React$1.RefAttributes<HTMLButtonElement>>;
+declare const DialogOverlay: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogOverlayProps & React$1.RefAttributes<HTMLDivElement>, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
+declare const DialogContent: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogContentProps & React$1.RefAttributes<HTMLDivElement>, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
+declare const DialogHeader: {
+    ({ className, ...props }: React$1.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+declare const DialogFooter: {
+    ({ className, ...props }: React$1.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+declare const DialogTitle: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogTitleProps & React$1.RefAttributes<HTMLHeadingElement>, "ref"> & React$1.RefAttributes<HTMLHeadingElement>>;
+declare const DialogDescription: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogDescriptionProps & React$1.RefAttributes<HTMLParagraphElement>, "ref"> & React$1.RefAttributes<HTMLParagraphElement>>;
+
+/**
+ * Propriedades para o componente SidebarContainer.
+ *
+ * @extends HTMLAttributes<HTMLDivElement>
+ */
+interface SidebarContainerProps extends React__default.HTMLAttributes<HTMLDivElement> {
+    /**
+     * Indica se o sidebar está aberto ou fechado.
+     * @default true
+    */
+    isOpen?: boolean;
+}
+declare function SidebarContainer({ isOpen, ...rest }: SidebarContainerProps): react_jsx_runtime.JSX.Element;
+interface SidebarImageBrandProps extends PropsWithChildren {
+    /** @param {boolean} [props.asChild=false] - Se `true`, e `children` for um elemento React válido, este será usado como logotipo. Se `img` também for fornecido, `img` terá precedência. Se `children` não for um elemento React válido, o comportamento padrão de exibir a imagem de `img` ou `children` como conteúdo será usado. */
+    asChild?: boolean;
+    /** @param {{ src?: string; alt?: string }} [props.img] - Objeto com as propriedades `src` e `alt` da imagem, usado quando `asChild` é `false` ou quando `asChild` é `true` mas `children` não é um elemento React válido para ser usado como logotipo. */
+    img?: {
+        src?: string;
+        alt?: string;
+    };
+    /** @param {ReactNode} [props.children] - Conteúdo personalizado ou elemento filho a ser exibido como logotipo quando `asChild` for `true` e `img` não for fornecido.  Normalmente usado para o botão de toggle ou um logotipo customizado. */
+    children?: ReactNode;
+    onChangeToggle?: () => void;
+}
+/**
+ * Componente para exibir a imagem da marca (logotipo) na barra lateral.
+ *
+ * Exibe uma imagem, um elemento filho como logotipo ou conteúdo personalizado na parte superior da barra lateral.
+ * Permite a inclusão de um botão de alternância (toggle) para colapsar a barra lateral.
+ * A prop `asChild` permite usar um elemento filho como logotipo, caso a prop `img` não seja fornecida.
+ */
+declare function SidebarImageBrand({ asChild, onChangeToggle, img, children }: SidebarImageBrandProps): react_jsx_runtime.JSX.Element;
+type AccordionRootProps = ComponentProps<typeof Accordion.Root>;
+type SidebarProps = AccordionRootProps & {
+    /** @param {ReactNode} props.children - Os elementos filhos a serem renderizados dentro do Sidebar. */
+    children?: AccordionRootProps['children'];
+    /** @param {'single' | 'multiple'} [props.type='single'] - Determina se um ou vários itens podem ser abertos simultaneamente. */
+    type: AccordionRootProps['type'];
+};
+/**
+ * Componente Sidebar, responsável por renderizar a estrutura principal do menu lateral
+ * e gerenciar o comportamento de acordeão dos itens de navegação.
+ *
+ * Este componente utiliza o Radix UI Accordion para controlar a expansão e o colapso
+ * dos itens do menu. O tipo de acordeão (único ou múltiplo) é determinado pela propriedade `type`.
+ *
+ * Estende as tipagens do componente `Accordion.Root` do Radix UI.
+ */
+declare function Siderbar({ children, ...rest }: SidebarProps): react_jsx_runtime.JSX.Element;
+/**
+ * Componente de link de navegação para o Sidebar.
+ *
+ * Renderiza um link com ícone e título, permitindo navegação dentro do Sidebar.
+ * Recomenda-se que o ícone fornecido tenha 20px de altura e largura para
+ * consistência visual.
+ *
+ * @param {SidebarNavLinkProps} props - As propriedades do componente.
+ * @param {ReactNode} props.children - O título do link e o icone que pode ser fornecido como componente ou svg (🚨recomendado 20px x 20px).
+ * @param {string} props.href O caminho para redirecionamento.
+ */
+interface SidebarNavLinkProps extends React__default.AnchorHTMLAttributes<HTMLAnchorElement> {
+    asChild?: boolean;
+    /**
+     * Determina se é principal ou filho de um collapse nav, 'primary' link solto e 'secondary' é utilizado no collapse.
+     * @default 'primary'
+     */
+    type?: 'primary' | 'secondary';
+}
+declare function SidebarNavLink({ asChild, type, ...rest }: SidebarNavLinkProps): react_jsx_runtime.JSX.Element;
+interface IconProps extends SVGProps<SVGSVGElement> {
+}
+interface SidebarNavCollapseProps extends Accordion.AccordionItemProps {
+    title: string;
+    icon?: ReactElement<IconProps> | ReactNode;
+}
+declare function SidebarNavCollapse({ children, title, icon, ...rest }: SidebarNavCollapseProps): react_jsx_runtime.JSX.Element;
+
+export { Button, type ButtonProps, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, Header, type HeaderProps, Modal, ModalMudancaEntidade, type ModalProps, SidebarContainer, type SidebarContainerProps, SidebarImageBrand, type SidebarImageBrandProps, SidebarNavCollapse, type SidebarNavCollapseProps, SidebarNavLink, type SidebarNavLinkProps, type SidebarProps, Siderbar, buttonVariants };

package/dist/index.d.ts

@@ -1,24 +1,139 @@
-import * as class_variance_authority_dist_types from 'class-variance-authority/dist/types';
-import { VariantProps } from 'class-variance-authority';
-import React from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-
-declare const buttonVariants: (props?: ({
-    variant?: "default" | "confirm" | "create" | "secondary" | "danger" | null | undefined;
-    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
-    outline?: boolean | null | undefined;
-} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
-interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
-    asChild?: boolean;
-    isLoading?: boolean;
-}
-declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
-
-type HeaderProps = {
-    userName: string;
-    imageUrl?: string;
-    entityName?: string;
-};
-declare const Header: ({ userName, entityName }: HeaderProps) => react_jsx_runtime.JSX.Element;
-
-export { Button, type ButtonProps, Header, type HeaderProps, buttonVariants };
+import * as class_variance_authority_dist_types from 'class-variance-authority/dist/types';
+import { VariantProps } from 'class-variance-authority';
+import * as React$1 from 'react';
+import React__default, { PropsWithChildren, ReactNode, ReactElement, ComponentProps, SVGProps } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as DialogPrimitive from '@radix-ui/react-dialog';
+import * as Accordion from '@radix-ui/react-accordion';
+
+declare const buttonVariants: (props?: ({
+    variant?: "default" | "confirm" | "create" | "secondary" | "danger" | null | undefined;
+    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
+    outline?: boolean | null | undefined;
+} & class_variance_authority_dist_types.ClassProp) | undefined) => string;
+interface ButtonProps extends React__default.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
+    asChild?: boolean;
+    isLoading?: boolean;
+}
+declare const Button: React__default.ForwardRefExoticComponent<ButtonProps & React__default.RefAttributes<HTMLButtonElement>>;
+
+type HeaderProps = {
+    userName: string;
+    imageUrl?: string;
+    entityName?: string;
+};
+declare const Header: ({ userName, entityName }: HeaderProps) => react_jsx_runtime.JSX.Element;
+
+type ModalProps = {
+    title?: string;
+    content?: React.ReactElement;
+    onClose?: any;
+    visibleModal?: boolean;
+};
+declare const Modal: ({ title, content, visibleModal, onClose, }: ModalProps) => react_jsx_runtime.JSX.Element;
+
+type ModalMudancaEnntidadeProps = {
+    title?: string;
+    onClose?: any;
+    visibleModal?: boolean;
+    SelectComponent?: any;
+    buttonAction: React__default.MouseEventHandler<HTMLButtonElement>;
+};
+declare const ModalMudancaEntidade: ({ title, onClose, visibleModal, SelectComponent, buttonAction, }: ModalMudancaEnntidadeProps) => react_jsx_runtime.JSX.Element;
+
+declare const Dialog: React$1.FC<DialogPrimitive.DialogProps>;
+declare const DialogTrigger: React$1.ForwardRefExoticComponent<DialogPrimitive.DialogTriggerProps & React$1.RefAttributes<HTMLButtonElement>>;
+declare const DialogPortal: React$1.FC<DialogPrimitive.DialogPortalProps>;
+declare const DialogClose: React$1.ForwardRefExoticComponent<DialogPrimitive.DialogCloseProps & React$1.RefAttributes<HTMLButtonElement>>;
+declare const DialogOverlay: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogOverlayProps & React$1.RefAttributes<HTMLDivElement>, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
+declare const DialogContent: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogContentProps & React$1.RefAttributes<HTMLDivElement>, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
+declare const DialogHeader: {
+    ({ className, ...props }: React$1.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+declare const DialogFooter: {
+    ({ className, ...props }: React$1.HTMLAttributes<HTMLDivElement>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+declare const DialogTitle: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogTitleProps & React$1.RefAttributes<HTMLHeadingElement>, "ref"> & React$1.RefAttributes<HTMLHeadingElement>>;
+declare const DialogDescription: React$1.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogDescriptionProps & React$1.RefAttributes<HTMLParagraphElement>, "ref"> & React$1.RefAttributes<HTMLParagraphElement>>;
+
+/**
+ * Propriedades para o componente SidebarContainer.
+ *
+ * @extends HTMLAttributes<HTMLDivElement>
+ */
+interface SidebarContainerProps extends React__default.HTMLAttributes<HTMLDivElement> {
+    /**
+     * Indica se o sidebar está aberto ou fechado.
+     * @default true
+    */
+    isOpen?: boolean;
+}
+declare function SidebarContainer({ isOpen, ...rest }: SidebarContainerProps): react_jsx_runtime.JSX.Element;
+interface SidebarImageBrandProps extends PropsWithChildren {
+    /** @param {boolean} [props.asChild=false] - Se `true`, e `children` for um elemento React válido, este será usado como logotipo. Se `img` também for fornecido, `img` terá precedência. Se `children` não for um elemento React válido, o comportamento padrão de exibir a imagem de `img` ou `children` como conteúdo será usado. */
+    asChild?: boolean;
+    /** @param {{ src?: string; alt?: string }} [props.img] - Objeto com as propriedades `src` e `alt` da imagem, usado quando `asChild` é `false` ou quando `asChild` é `true` mas `children` não é um elemento React válido para ser usado como logotipo. */
+    img?: {
+        src?: string;
+        alt?: string;
+    };
+    /** @param {ReactNode} [props.children] - Conteúdo personalizado ou elemento filho a ser exibido como logotipo quando `asChild` for `true` e `img` não for fornecido.  Normalmente usado para o botão de toggle ou um logotipo customizado. */
+    children?: ReactNode;
+    onChangeToggle?: () => void;
+}
+/**
+ * Componente para exibir a imagem da marca (logotipo) na barra lateral.
+ *
+ * Exibe uma imagem, um elemento filho como logotipo ou conteúdo personalizado na parte superior da barra lateral.
+ * Permite a inclusão de um botão de alternância (toggle) para colapsar a barra lateral.
+ * A prop `asChild` permite usar um elemento filho como logotipo, caso a prop `img` não seja fornecida.
+ */
+declare function SidebarImageBrand({ asChild, onChangeToggle, img, children }: SidebarImageBrandProps): react_jsx_runtime.JSX.Element;
+type AccordionRootProps = ComponentProps<typeof Accordion.Root>;
+type SidebarProps = AccordionRootProps & {
+    /** @param {ReactNode} props.children - Os elementos filhos a serem renderizados dentro do Sidebar. */
+    children?: AccordionRootProps['children'];
+    /** @param {'single' | 'multiple'} [props.type='single'] - Determina se um ou vários itens podem ser abertos simultaneamente. */
+    type: AccordionRootProps['type'];
+};
+/**
+ * Componente Sidebar, responsável por renderizar a estrutura principal do menu lateral
+ * e gerenciar o comportamento de acordeão dos itens de navegação.
+ *
+ * Este componente utiliza o Radix UI Accordion para controlar a expansão e o colapso
+ * dos itens do menu. O tipo de acordeão (único ou múltiplo) é determinado pela propriedade `type`.
+ *
+ * Estende as tipagens do componente `Accordion.Root` do Radix UI.
+ */
+declare function Siderbar({ children, ...rest }: SidebarProps): react_jsx_runtime.JSX.Element;
+/**
+ * Componente de link de navegação para o Sidebar.
+ *
+ * Renderiza um link com ícone e título, permitindo navegação dentro do Sidebar.
+ * Recomenda-se que o ícone fornecido tenha 20px de altura e largura para
+ * consistência visual.
+ *
+ * @param {SidebarNavLinkProps} props - As propriedades do componente.
+ * @param {ReactNode} props.children - O título do link e o icone que pode ser fornecido como componente ou svg (🚨recomendado 20px x 20px).
+ * @param {string} props.href O caminho para redirecionamento.
+ */
+interface SidebarNavLinkProps extends React__default.AnchorHTMLAttributes<HTMLAnchorElement> {
+    asChild?: boolean;
+    /**
+     * Determina se é principal ou filho de um collapse nav, 'primary' link solto e 'secondary' é utilizado no collapse.
+     * @default 'primary'
+     */
+    type?: 'primary' | 'secondary';
+}
+declare function SidebarNavLink({ asChild, type, ...rest }: SidebarNavLinkProps): react_jsx_runtime.JSX.Element;
+interface IconProps extends SVGProps<SVGSVGElement> {
+}
+interface SidebarNavCollapseProps extends Accordion.AccordionItemProps {
+    title: string;
+    icon?: ReactElement<IconProps> | ReactNode;
+}
+declare function SidebarNavCollapse({ children, title, icon, ...rest }: SidebarNavCollapseProps): react_jsx_runtime.JSX.Element;
+
+export { Button, type ButtonProps, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, Header, type HeaderProps, Modal, ModalMudancaEntidade, type ModalProps, SidebarContainer, type SidebarContainerProps, SidebarImageBrand, type SidebarImageBrandProps, SidebarNavCollapse, type SidebarNavCollapseProps, SidebarNavLink, type SidebarNavLinkProps, type SidebarProps, Siderbar, buttonVariants };