pge-front-common 14.0.39 → 14.0.41

package/lib/components/Switch/index.d.ts

@@ -0,0 +1,36 @@
+import React from "react";
+import { SwitchProps } from "./index.types";
+/**
+ * Componente Switch suportado por eventos de mouse e teclado.
+ *
+ * @description
+ * Componente que mostra um estado boolean, informando se a opção está ligada/desligada.
+ *
+ * @param {boolean} props.checked                  - Mostra se o componente está marcado (`true`) ou desmarcado (`false`).
+ * @param {(newValue: boolean) => void} props.onChange
+ *                                                - Função callback chamada no evento de clique e que retorna o novo estado (`true` ou `false`).
+ * @param {boolean} [props.disabled=false]         - Se estiver como `true` o usuário fica impossibilitado de interagir com o elemento.
+ * @param {...any} [props.props]                   - Quaisquer outras props suportadas pelo elemento HTML do tipo input (e.g. `id`, `name`, `aria-*`).
+ *
+ * @example
+ * ```tsx
+ * import React, { useState } from "react";
+ * import { Switch } from "pge-front-common";
+ *
+ * export const Example = () => {
+ *   const [enabled, setEnabled] = useState(false);
+ *
+ *   return (
+ *     <div>
+ *       <Switch
+ *         checked={enabled}
+ *         onChange={(newState) => setEnabled(newState)}
+ *         aria-label="Sim ou não"
+ *       />
+ *       <span>{enabled ? "Sim" : "Não"}</span>
+ *     </div>
+ *   );
+ * };
+ * ```
+ */
+export declare const Switch: ({ checked, onChange, disabled, className, ...props }: SwitchProps) => React.JSX.Element;

package/lib/components/Switch/index.types.d.ts

@@ -0,0 +1,7 @@
+import { InputHTMLAttributes } from "react";
+export interface SwitchProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "onChange"> {
+    checked: boolean;
+    onChange: (newValue: boolean) => void;
+    disabled?: boolean;
+    className?: string;
+}

package/lib/components/Switch/switch.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta } from "@storybook/react";
+import { Switch } from "./index";
+import type { SwitchProps } from "./index.types";
+declare const _default: Meta<typeof Switch>;
+export default _default;
+export declare const Checked: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, SwitchProps>;
+export declare const DisabledUnchecked: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, SwitchProps>;
+export declare const DisabledChecked: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, SwitchProps>;
+export declare const WithCustomClass: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, SwitchProps>;

package/lib/index.d.ts

@@ -472,6 +472,48 @@ declare const TableRow: ({ children, ...props }: TableRowProps) => React__defaul
 declare const TableCell: ({ children, ...props }: TableCellProps) => React__default.JSX.Element;
 declare const TableFooter: ({ children, ...props }: TableFooterProps) => React__default.JSX.Element;
 
+interface SwitchProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "onChange"> {
+    checked: boolean;
+    onChange: (newValue: boolean) => void;
+    disabled?: boolean;
+    className?: string;
+}
+
+/**
+ * Componente Switch suportado por eventos de mouse e teclado.
+ *
+ * @description
+ * Componente que mostra um estado boolean, informando se a opção está ligada/desligada.
+ *
+ * @param {boolean} props.checked                  - Mostra se o componente está marcado (`true`) ou desmarcado (`false`).
+ * @param {(newValue: boolean) => void} props.onChange
+ *                                                - Função callback chamada no evento de clique e que retorna o novo estado (`true` ou `false`).
+ * @param {boolean} [props.disabled=false]         - Se estiver como `true` o usuário fica impossibilitado de interagir com o elemento.
+ * @param {...any} [props.props]                   - Quaisquer outras props suportadas pelo elemento HTML do tipo input (e.g. `id`, `name`, `aria-*`).
+ *
+ * @example
+ * ```tsx
+ * import React, { useState } from "react";
+ * import { Switch } from "pge-front-common";
+ *
+ * export const Example = () => {
+ *   const [enabled, setEnabled] = useState(false);
+ *
+ *   return (
+ *     <div>
+ *       <Switch
+ *         checked={enabled}
+ *         onChange={(newState) => setEnabled(newState)}
+ *         aria-label="Sim ou não"
+ *       />
+ *       <span>{enabled ? "Sim" : "Não"}</span>
+ *     </div>
+ *   );
+ * };
+ * ```
+ */
+declare const Switch: ({ checked, onChange, disabled, className, ...props }: SwitchProps) => React__default.JSX.Element;
+
 declare const IconDownload: (props?: SVGProps<SVGSVGElement>) => React__default.JSX.Element;
 
 declare const IconVisibility: (props?: SVGProps<SVGSVGElement>) => React__default.JSX.Element;
@@ -558,4 +600,4 @@ declare const IconUsers: ({ className, ...props }: SVGProps<SVGSVGElement>) => R
 
 declare function installPrimeReactStyles(): void;
 
-export { Accordion, AccordionItem, type AccordionItemProps, BasicSelect, Blanket, BoxError, BoxSuccess, Button, type ButtonProps, Checkbox, type Column, CommonDotIcon, DateInput, Dropdown, FileUpload, FooterPge as Footer, Header, HeaderPge, IconAdd, IconAddCell, IconArrowExpland, IconArrowRecall, IconCLose, IconCalendar, IconCheck, IconCheckCircle, IconCircleExpland, IconCircleRecall, IconDelete, IconDownload, IconEdit, IconEventAvaliable, IconExclude, IconHourglass, IconInfoRound, IconInvisibility, IconLeftDirection, IconLogout, IconMail, IconNewTab, IconPdf, IconPrint, IconProfile, IconQuestionMark, IconRemove, IconRightDirection, IconSearch, IconSwap, IconTriangleExpand, IconTriangleRecall, IconUpAndDownArror, IconUpload, IconUploadFile, IconUploadFile2, IconUploadV2, IconUsers, IconView, IconVisibility, IconWarning, InformativeBox, type InformativeBoxProps, InputBase, type InputProps, LoadingSpinner, Menu, MenuAction, MenuList, Modal, ModalBody, ModalFooter, ModalHeader, ModalUI, Option, type OptionsProps$2 as OptionsProps, PaginationTable, Pagination as PaginationV2, PasswordInput, PgeButton, RadioGroupBase, type RadioGroupBaseProps, SelectDefault, type SelectDefaultProps, SelectMult, type SelectMultProps, SkeletonLoader, Table, TableBody, TableCell, TableComponent, type TableComponentProps, TableFooter, TableHeader, TableRow, TextareaBase, type TextareaBaseProps, Title, Tooltip, TooltipWithPortal, installPrimeReactStyles };
+export { Accordion, AccordionItem, type AccordionItemProps, BasicSelect, Blanket, BoxError, BoxSuccess, Button, type ButtonProps, Checkbox, type Column, CommonDotIcon, DateInput, Dropdown, FileUpload, FooterPge as Footer, Header, HeaderPge, IconAdd, IconAddCell, IconArrowExpland, IconArrowRecall, IconCLose, IconCalendar, IconCheck, IconCheckCircle, IconCircleExpland, IconCircleRecall, IconDelete, IconDownload, IconEdit, IconEventAvaliable, IconExclude, IconHourglass, IconInfoRound, IconInvisibility, IconLeftDirection, IconLogout, IconMail, IconNewTab, IconPdf, IconPrint, IconProfile, IconQuestionMark, IconRemove, IconRightDirection, IconSearch, IconSwap, IconTriangleExpand, IconTriangleRecall, IconUpAndDownArror, IconUpload, IconUploadFile, IconUploadFile2, IconUploadV2, IconUsers, IconView, IconVisibility, IconWarning, InformativeBox, type InformativeBoxProps, InputBase, type InputProps, LoadingSpinner, Menu, MenuAction, MenuList, Modal, ModalBody, ModalFooter, ModalHeader, ModalUI, Option, type OptionsProps$2 as OptionsProps, PaginationTable, Pagination as PaginationV2, PasswordInput, PgeButton, RadioGroupBase, type RadioGroupBaseProps, SelectDefault, type SelectDefaultProps, SelectMult, type SelectMultProps, SkeletonLoader, Switch, Table, TableBody, TableCell, TableComponent, type TableComponentProps, TableFooter, TableHeader, TableRow, TextareaBase, type TextareaBaseProps, Title, Tooltip, TooltipWithPortal, installPrimeReactStyles };