@code-sherpas/pharos-react 0.14.3 → 0.15.0

package/dist/components/Sheet.d.ts

@@ -0,0 +1,112 @@
+import { ComponentProps, ComponentPropsWithoutRef } from 'react';
+import { Dialog } from '@base-ui/react/dialog';
+import { VariantProps } from 'class-variance-authority';
+/**
+ * Modal panel that docks to a viewport edge and slides in (the shadcn
+ * **Sheet** contract). Wraps Base UI's `Dialog.*`, which implements the ARIA
+ * **dialog** pattern as a **modal** disclosure: `role="dialog"` +
+ * `aria-modal`, focus trapped inside the panel, scroll locked, Escape and
+ * backdrop-click dismiss, focus returns to the trigger on close.
+ *
+ * Distinct from `Popover` (D16, non-modal, anchored to its trigger) and
+ * `DropdownMenu` (D15, menu-button). A Sheet is for a task surface that
+ * should command the screen — mobile navigation, a filters panel, a
+ * create/edit form. Naming follows shadcn (`Sheet*`); the compound surface
+ * collapses Base UI's `Portal` + `Backdrop` + `Popup` into a single
+ * `SheetContent` with a `side` prop, mirroring the ergonomics of the other
+ * Pharos overlays.
+ *
+ * v1 ships the parts the known consumers need (the LanguageSelector /
+ * MobileDrawer): Trigger, Content, Header, Footer, Title, Description, Close.
+ *
+ * @example
+ * <Sheet>
+ *   <SheetTrigger render={<Button intent="secondary">Menu</Button>} />
+ *   <SheetContent side="left">
+ *     <SheetHeader>
+ *       <SheetTitle>Navigation</SheetTitle>
+ *       <SheetDescription>Jump to a section.</SheetDescription>
+ *     </SheetHeader>
+ *     <nav>…</nav>
+ *     <SheetFooter>
+ *       <SheetClose render={<Button intent="ghost">Close</Button>} />
+ *     </SheetFooter>
+ *   </SheetContent>
+ * </Sheet>
+ */
+export type SheetProps = ComponentProps<typeof Dialog.Root>;
+export declare function Sheet(props: SheetProps): import("react").JSX.Element;
+export declare namespace Sheet {
+    var displayName: string;
+}
+/**
+ * The element that opens the sheet. Renders a native `<button>` by default;
+ * pass `render` to compose any control (`render={<Button…/>}`,
+ * `render={<IconButton…/>}`).
+ */
+export type SheetTriggerProps = ComponentProps<typeof Dialog.Trigger>;
+export declare function SheetTrigger(props: SheetTriggerProps): import("react").JSX.Element;
+export declare namespace SheetTrigger {
+    var displayName: string;
+}
+declare const sheetVariants: (props?: ({
+    side?: "left" | "right" | "bottom" | "top" | null | undefined;
+} & import('class-variance-authority/types').ClassProp) | undefined) => string;
+type SheetVariantProps = VariantProps<typeof sheetVariants>;
+/**
+ * The panel surface. Collapses Base UI's `Portal` + `Backdrop` + `Popup`. The
+ * `side` prop docks it to one of the four viewport edges (default `right`)
+ * and picks the matching slide-in transition. The backdrop and panel share
+ * the `--pharos-z-index-popover` overlay layer so a Select / Popover opened
+ * from inside the sheet still stacks above it (portal open order).
+ */
+export interface SheetContentProps extends ComponentProps<typeof Dialog.Popup>, SheetVariantProps {
+}
+export declare function SheetContent({ side, className, children, ...rest }: SheetContentProps): import("react").JSX.Element;
+export declare namespace SheetContent {
+    var displayName: string;
+}
+/** Groups the title + description at the top of the panel. */
+export interface SheetHeaderProps extends ComponentPropsWithoutRef<'div'> {
+}
+export declare function SheetHeader({ className, ...rest }: SheetHeaderProps): import("react").JSX.Element;
+export declare namespace SheetHeader {
+    var displayName: string;
+}
+/**
+ * The panel's accessible name. Renders Base UI's `Dialog.Title`, which wires
+ * `aria-labelledby` on the popup — required for the dialog to be announced.
+ * Renders as an `<h2>` by default.
+ */
+export type SheetTitleProps = ComponentProps<typeof Dialog.Title>;
+export declare function SheetTitle({ className, ...rest }: SheetTitleProps): import("react").JSX.Element;
+export declare namespace SheetTitle {
+    var displayName: string;
+}
+/**
+ * Supporting copy under the title. Renders Base UI's `Dialog.Description`,
+ * which wires `aria-describedby` on the popup. Renders as a `<p>` by default.
+ */
+export type SheetDescriptionProps = ComponentProps<typeof Dialog.Description>;
+export declare function SheetDescription({ className, ...rest }: SheetDescriptionProps): import("react").JSX.Element;
+export declare namespace SheetDescription {
+    var displayName: string;
+}
+/** Bottom action row, pushed to the panel's end. */
+export interface SheetFooterProps extends ComponentPropsWithoutRef<'div'> {
+}
+export declare function SheetFooter({ className, ...rest }: SheetFooterProps): import("react").JSX.Element;
+export declare namespace SheetFooter {
+    var displayName: string;
+}
+/**
+ * A button that closes the sheet. Renders Base UI's `Dialog.Close` (a native
+ * `<button>`); compose any control via `render`.
+ */
+export type SheetCloseProps = ComponentProps<typeof Dialog.Close>;
+export declare function SheetClose(props: SheetCloseProps): import("react").JSX.Element;
+export declare namespace SheetClose {
+    var displayName: string;
+}
+export { sheetVariants };
+//# sourceMappingURL=Sheet.d.ts.map

package/dist/components/Sheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sheet.d.ts","sourceRoot":"","sources":["../../src/components/Sheet.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAO,KAAK,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAIlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AAE5D,wBAAgB,KAAK,CAAC,KAAK,EAAE,UAAU,+BAEtC;yBAFe,KAAK;;;AAMrB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AAEtE,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,+BAEpD;yBAFe,YAAY;;;AAM5B,QAAA,MAAM,aAAa;;8EAYjB,CAAC;AAEH,KAAK,iBAAiB,GAAG,YAAY,CAAC,OAAO,aAAa,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,cAAc,CAAC,OAAO,MAAM,CAAC,KAAK,CAAC,EAAE,iBAAiB;CAAG;AAEpG,wBAAgB,YAAY,CAAC,EAAE,IAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,iBAAiB,+BAc/F;yBAde,YAAY;;;AAkB5B,8DAA8D;AAC9D,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB,CAAC,KAAK,CAAC;CAAG;AAE5E,wBAAgB,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB,+BAEnE;yBAFe,WAAW;;;AAM3B;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AAElE,wBAAgB,UAAU,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,eAAe,+BAQjE;yBARe,UAAU;;;AAY1B;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAAC,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;AAE9E,wBAAgB,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,qBAAqB,+BAQ7E;yBARe,gBAAgB;;;AAYhC,oDAAoD;AACpD,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB,CAAC,KAAK,CAAC;CAAG;AAE5E,wBAAgB,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB,+BAEnE;yBAFe,WAAW;;;AAM3B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AAElE,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,+BAEhD;yBAFe,UAAU;;;AAM1B,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/index.d.ts

@@ -24,5 +24,7 @@ export { Select, SelectTrigger, SelectValue, SelectContent, SelectItem, SelectGr
 export type { SelectProps, SelectTriggerProps, SelectValueProps, SelectContentProps, SelectItemProps, SelectGroupProps, SelectLabelProps, SelectSeparatorProps, } from './components/Select';
 export { Combobox, ComboboxControl, ComboboxChips, ComboboxInput, ComboboxTrigger, ComboboxClear, ComboboxChip, ComboboxChipRemove, ComboboxContent, ComboboxList, ComboboxItem, ComboboxEmpty, ComboboxGroup, ComboboxGroupLabel, ComboboxSeparator, } from './components/Combobox';
 export type { ComboboxProps, ComboboxControlProps, ComboboxChipsProps, ComboboxInputProps, ComboboxTriggerProps, ComboboxClearProps, ComboboxChipProps, ComboboxChipRemoveProps, ComboboxContentProps, ComboboxListProps, ComboboxItemProps, ComboboxEmptyProps, ComboboxGroupProps, ComboboxGroupLabelProps, ComboboxSeparatorProps, } from './components/Combobox';
+export { Sheet, SheetTrigger, SheetContent, SheetHeader, SheetTitle, SheetDescription, SheetFooter, SheetClose, sheetVariants, } from './components/Sheet';
+export type { SheetProps, SheetTriggerProps, SheetContentProps, SheetHeaderProps, SheetTitleProps, SheetDescriptionProps, SheetFooterProps, SheetCloseProps, } from './components/Sheet';
 export { cn } from './lib/cn';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1D,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1D,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACnE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EACL,IAAI,EACJ,UAAU,EACV,SAAS,EACT,eAAe,EACf,WAAW,EACX,UAAU,EACV,YAAY,GACb,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvF,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,0BAA0B,EAC1B,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,OAAO,EACP,cAAc,EACd,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,YAAY,GACb,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,aAAa,EACb,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,WAAW,EACX,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,QAAQ,EACR,eAAe,EACf,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACzE,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1D,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1D,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACnE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EACL,IAAI,EACJ,UAAU,EACV,SAAS,EACT,eAAe,EACf,WAAW,EACX,UAAU,EACV,YAAY,GACb,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvF,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,0BAA0B,EAC1B,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,OAAO,EACP,cAAc,EACd,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,YAAY,GACb,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,aAAa,EACb,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,WAAW,EACX,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,QAAQ,EACR,eAAe,EACf,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,aAAa,GACd,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,UAAU,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC"}