@easypost/easy-ui 1.0.0-alpha.6 → 1.0.0-alpha.60

package/SearchNav/PrimaryCTAItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrimaryCTAItem.d.ts","sourceRoot":"","sources":["../../src/SearchNav/PrimaryCTAItem.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAG7C,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,GAAG;IACrD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAE/C,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,qBAQxD;yBARe,cAAc"}

package/SearchNav/Search.d.ts

@@ -0,0 +1,13 @@
+import React, { ReactNode } from "react";
+export type SearchProps = {
+    /**
+     * The children of the <SearchNav.Search> element. Should render
+     * a search component.
+     */
+    children: ReactNode;
+};
+export declare function Search(props: SearchProps): React.JSX.Element;
+export declare namespace Search {
+    var displayName: string;
+}
+//# sourceMappingURL=Search.d.ts.map

package/SearchNav/Search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Search.d.ts","sourceRoot":"","sources":["../../src/SearchNav/Search.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIzC,MAAM,MAAM,WAAW,GAAG;IACxB;;;OAGG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,wBAAgB,MAAM,CAAC,KAAK,EAAE,WAAW,qBAIxC;yBAJe,MAAM"}

package/SearchNav/SearchNav.d.ts

@@ -0,0 +1,105 @@
+import React, { ReactNode } from "react";
+import { MenuOverlayProps } from "../Menu/MenuOverlay";
+import { SelectOption } from "../Select/SelectOption";
+import { IconSymbol } from "../types";
+export type SearchNavOverlayMenuProps<T> = Omit<MenuOverlayProps<T>, "children" | "maxItemsUntilScroll" | "placement" | "width">;
+export type SearchNavProps<T> = {
+    /**
+     * Overlay props that apply to condensed menu configurations. Note that
+     * the keys defined in <SearchNav> will be preserved.
+     */
+    menuOverlayProps?: SearchNavOverlayMenuProps<T>;
+    /**
+     * Symbol for collapsed CTA menu, symbol SVG source from @easypost/easy-ui-icons.
+     */
+    ctaMenuSymbol?: IconSymbol;
+    /**
+     * The children of the <SearchNav> element. Should render `<SearchNav.LogoGroup>`,
+     * `<SearchNav.Search>`, and `<SearchNav.CTAGroup>`
+     */
+    children: ReactNode;
+    /**
+     * Defines the behavior in which the menu condenses on mobile screens.
+     *
+     * @default collapse-to-menu
+     */
+    condensedBehavior?: "collapse-to-menu" | "preserve-logo";
+};
+/**
+ * The `<SearchNav />` component is a navigation bar focused on handling dense information interactions.
+ *
+ * @remarks
+ * Use on a docs page where users can leverage a dropdown, a seach input, and CTAs to find information.
+ * `<SearchNav.LogoGroup />` and `<SearchNav.Logo />` are required.
+ *
+ * @example
+ * _Full nav bar:_
+*```tsx
+* import { SearchComponent } from "library";
+* import { SearchNav } from "@easypost/easy-ui/SearchNav";
+* import Campaign from "@easypost/easy-ui-icons/Campaign";
+* import Help from "@easypost/easy-ui-icons/Help";
+* import Brightness5 from "@easypost/easy-ui-icons/Brightness5";
+* import React from "react";
+*
+* function App() {
+* const [selectedOption, setSelectedOption] = React.useState("V1.0");
+*
+*  return (
+*    <SearchNav
+*      menuOverlayProps={{
+*        onAction: (key) => {},
+*        disabledKeys: ["V99.99"],
+*      }}
+*    >
+*      <SearchNav.LogoGroup>
+*        <SearchNav.Logo>
+*          <img alt="some logo" />
+*        </SearchNav.Logo>
+*        <SearchNav.Title>Docs</SearchNav.Title>
+*        <SearchNav.Selector
+*          label="docs version"
+*          defaultSelectedKey="V1.0"
+*          disabledKeys={["V99.99"]}
+*          selectedKey={selectedOption}
+*          onSelectionChange={(selected) => setSelectedOption(selected)}
+*        >
+*          <SearchNav.Option key="V1.0">V1.0</SearchNav.Option>
+*          <SearchNav.Option key="V1.1">V1.1</SearchNav.Option>
+*          <SearchNav.Option key="V99.99">V99.99</SearchNav.Option>
+*        </SearchNav.Selector>
+*      </SearchNav.LogoGroup>
+*      <SearchNav.Search>
+*        <SearchComponent />
+*      </SearchNav.Search>
+*      <SearchNav.CTAGroup>
+*        <SearchNav.SecondaryCTAItem symbol={Campaign} key="Campaign" label="Optional" />
+*        <SearchNav.SecondaryCTAItem symbol={Help} key="Help" label="Optional" />
+*        <SearchNav.SecondaryCTAItem
+*          symbol={Brightness5}
+*          key="Brightness"
+*          label="Toggle theme"
+*          hideLabelOnDesktop
+*        />
+*        <SearchNav.PrimaryCTAItem
+*          label="Sign up"
+*        />
+*      </SearchNav.CTAGroup>
+*    </SearchNav>
+*  );
+* }
+```
+ */
+export declare function SearchNav<T>(props: SearchNavProps<T>): React.JSX.Element;
+export declare namespace SearchNav {
+    var LogoGroup: typeof import("./LogoGroup").LogoGroup;
+    var Logo: typeof import("./Logo").Logo;
+    var Title: typeof import("./Title").Title;
+    var Selector: typeof import("./Selector").Selector;
+    var Option: typeof SelectOption;
+    var Search: typeof import("./Search").Search;
+    var CTAGroup: typeof import("./CTAGroup").CTAGroup;
+    var PrimaryCTAItem: typeof import("./PrimaryCTAItem").PrimaryCTAItem;
+    var SecondaryCTAItem: typeof import("./SecondaryCTAItem").SecondaryCTAItem;
+}
+//# sourceMappingURL=SearchNav.d.ts.map

package/SearchNav/SearchNav.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchNav.d.ts","sourceRoot":"","sources":["../../src/SearchNav/SearchNav.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAW,MAAM,OAAO,CAAC;AAUlD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAUtC,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,IAAI,CAC7C,gBAAgB,CAAC,CAAC,CAAC,EACnB,UAAU,GAAG,qBAAqB,GAAG,WAAW,GAAG,OAAO,CAC3D,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAChD;;OAEG;IACH,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B;;;OAGG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,eAAe,CAAC;CAC1D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,qBAkEpD;yBAlEe,SAAS"}

package/SearchNav/SearchNav.stories.d.ts

@@ -0,0 +1,14 @@
+import { Meta, StoryObj } from "@storybook/react";
+import { SearchNav } from "./SearchNav";
+type Story = StoryObj<typeof SearchNav>;
+declare const meta: Meta<typeof SearchNav>;
+export default meta;
+export declare const Simple: Story;
+export declare const Title: Story;
+export declare const Selector: Story;
+export declare const SecondaryCTA: Story;
+export declare const PrimaryCTA: Story;
+export declare const Search: Story;
+export declare const FullBar: Story;
+export declare const PreserveLogoWhenCondensed: Story;
+//# sourceMappingURL=SearchNav.stories.d.ts.map

package/SearchNav/SearchNav.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchNav.stories.d.ts","sourceRoot":"","sources":["../../src/SearchNav/SearchNav.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAMlD,OAAO,EAAE,SAAS,EAAkB,MAAM,aAAa,CAAC;AAGxD,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;AAiBxC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,SAAS,CAQhC,CAAC;AAEF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,MAAM,EAAE,KAapB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,KAcnB,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,KAyBtB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KA8C1B,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KA+CxB,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KA6BpB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,KAuDrB,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,KA8BvC,CAAC"}

package/SearchNav/SearchNav.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SearchNav.test.d.ts.map

package/SearchNav/SearchNav.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchNav.test.d.ts","sourceRoot":"","sources":["../../src/SearchNav/SearchNav.test.tsx"],"names":[],"mappings":""}

package/SearchNav/SecondaryCTAItem.d.ts

@@ -0,0 +1,23 @@
+import React, { Key } from "react";
+import { CTAItemProps } from "./PrimaryCTAItem";
+import { IconSymbol } from "../types";
+export type SecondaryCTAItemProps = CTAItemProps & {
+    /**
+     * Icon symbol SVG source from @easypost/easy-ui-icons.
+     */
+    symbol?: IconSymbol;
+    /**
+     * Hides label on desktop.
+     * @default false
+     */
+    hideLabelOnDesktop?: boolean;
+    /**
+     * Key to link to <Menu.Item />
+     */
+    key: Key;
+};
+export declare function SecondaryCTAItem(props: SecondaryCTAItemProps): React.JSX.Element;
+export declare namespace SecondaryCTAItem {
+    var displayName: string;
+}
+//# sourceMappingURL=SecondaryCTAItem.d.ts.map

package/SearchNav/SecondaryCTAItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecondaryCTAItem.d.ts","sourceRoot":"","sources":["../../src/SearchNav/SecondaryCTAItem.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAOtC,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,qBAS5D;yBATe,gBAAgB"}

package/SearchNav/Selector.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { AriaSelectProps } from "react-aria";
+import { BaseSelectProps } from "../Select";
+export type SelectorProps<T> = AriaSelectProps<T> & BaseSelectProps<T> & {
+    /**
+     * aria-label that applies to expanded <SearchNav.Select> and
+     * to <Menu.Section> when <SearchNav> collapses.
+     */
+    "aria-label": string;
+};
+export declare function Selector<T extends object>(props: SelectorProps<T>): React.JSX.Element;
+export declare namespace Selector {
+    var displayName: string;
+}
+//# sourceMappingURL=Selector.d.ts.map

package/SearchNav/Selector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Selector.d.ts","sourceRoot":"","sources":["../../src/SearchNav/Selector.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAkB,MAAM,OAAO,CAAC;AAEvC,OAAO,EAAE,eAAe,EAAa,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAM5C,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAC/C,eAAe,CAAC,CAAC,CAAC,GAAG;IACnB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEJ,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,qBA6BjE;yBA7Be,QAAQ"}

package/SearchNav/SelectorTrigger.d.ts

@@ -0,0 +1,14 @@
+import React, { DOMAttributes } from "react";
+import { FocusableElement } from "@react-types/shared";
+export type SelectorTriggerProps = {
+    /**
+     * Field value props.
+     */
+    valueProps?: DOMAttributes<FocusableElement>;
+    /**
+     * Label to apply to <HiddenSelect>.
+     */
+    label: string;
+};
+export declare function SelectorTrigger(props: SelectorTriggerProps): React.JSX.Element;
+//# sourceMappingURL=SelectorTrigger.d.ts.map

package/SearchNav/SelectorTrigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectorTrigger.d.ts","sourceRoot":"","sources":["../../src/SearchNav/SelectorTrigger.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AASvD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,qBAoB1D"}

package/SearchNav/Separator.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export type SeparatorProps = {
+    /**
+     * Group separator between items.
+     */
+    group: "logo" | "cta";
+};
+export declare function Separator(props: SeparatorProps): React.JSX.Element;
+//# sourceMappingURL=Separator.d.ts.map

package/SearchNav/Separator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Separator.d.ts","sourceRoot":"","sources":["../../src/SearchNav/Separator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC;CACvB,CAAC;AAEF,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,qBAW9C"}

package/SearchNav/Title.d.ts

@@ -0,0 +1,12 @@
+import React, { ReactNode } from "react";
+export type TitleProps = {
+    /**
+     * Text content to display.
+     */
+    children: ReactNode;
+};
+export declare function Title(props: TitleProps): React.JSX.Element;
+export declare namespace Title {
+    var displayName: string;
+}
+//# sourceMappingURL=Title.d.ts.map

package/SearchNav/Title.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Title.d.ts","sourceRoot":"","sources":["../../src/SearchNav/Title.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGzC,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,wBAAgB,KAAK,CAAC,KAAK,EAAE,UAAU,qBAQtC;yBARe,KAAK"}

package/SearchNav/context.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from "react";
+import type { SearchNavOverlayMenuProps, SearchNavProps } from "./SearchNav";
+import { IconSymbol } from "../types";
+type InternalSearchNavContextType = {
+    logo: ReactNode;
+    title?: ReactNode;
+    selector?: ReactNode;
+    selectorChildren?: ReactNode[];
+    primaryCTAItem?: ReactNode;
+    secondaryCTAItems?: ReactNode[];
+    search?: ReactNode;
+    menuOverlayProps?: SearchNavOverlayMenuProps<object>;
+    selectorLabel?: string;
+    ctaMenuSymbol?: IconSymbol;
+    condensedBehavior?: SearchNavProps<object>["condensedBehavior"];
+};
+export declare const InternalSearchNavContext: import("react").Context<InternalSearchNavContextType | null>;
+export declare function useInternalSearchNavContext(): InternalSearchNavContextType;
+export {};
+//# sourceMappingURL=context.d.ts.map

package/SearchNav/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/SearchNav/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7D,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,KAAK,4BAA4B,GAAG;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC;IAC/B,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,iBAAiB,CAAC,EAAE,SAAS,EAAE,CAAC;IAChC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,gBAAgB,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,iBAAiB,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,mBAAmB,CAAC,CAAC;CACjE,CAAC;AAEF,eAAO,MAAM,wBAAwB,8DACqB,CAAC;AAE3D,wBAAgB,2BAA2B,iCAQ1C"}

package/SearchNav/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SearchNav";
+//# sourceMappingURL=index.d.ts.map

package/SearchNav/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/SearchNav/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}