@baton8/general-components 1.0.0

package/dist/components/modules/stepper/stepper.d.ts

@@ -0,0 +1,22 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const Stepper: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /**
+     * 現在進行中のステップのインデックス (0 始まり)。
+     * `-1` を指定した場合は、最初のステップよりも前の状態を表し、全てのステップが未完了の状態になります。
+     * ステップ数以上の値を指定した場合は、全てのステップが完了済みの状態になります。
+     * @defaultValue `-1`
+     */
+    activeIndex?: number | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLOListElement>>;

package/dist/components/modules/stepper/stepper.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+import { Stepper } from "../../../components";
+type Meta = RawMeta<typeof Stepper>;
+type Story = RawStory<typeof Stepper>;
+declare const meta: Meta;
+export declare const Basic: Story;
+export declare const MoreOption: Story;
+export default meta;

package/dist/components/modules/stepper/stepperBody.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const StepperBody: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/modules/stepper/stepperItem.d.ts

@@ -0,0 +1,17 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const StepperItem: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    scheme?: "primary" | "secondary" | "blue" | "red" | "green" | "pink" | "yellow" | "purple" | "orange" | "gray" | "gold" | "silver" | "bronze" | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLLIElement>>;

package/dist/components/modules/stepper/stepperNumber.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const StepperNumber: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/modules/stepper/stepperTitle.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const StepperTitle: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /**
+     * 使用する HTML タグの名前。
+     * @defaultValue `"h3"`
+     */
+    as?: keyof JSX.IntrinsicElements | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/modules/tabList/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./tabList";
+export * from "./tab";
+export * from "./tabIconContainer";

package/dist/components/modules/tabList/tab.d.ts

@@ -0,0 +1,21 @@
+import { MouseEvent, ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const Tab: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined; /** */
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    isActive?: boolean | undefined;
+    /** */
+    href?: string | undefined;
+    /** */
+    onClick?: ((event: MouseEvent<HTMLElement>) => unknown) | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLElement>>;

package/dist/components/modules/tabList/tabIconContainer.d.ts

@@ -0,0 +1,15 @@
+import { ReactElement } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const TabIconContainer: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactElement<any, string | import("react").JSXElementConstructor<any>> | undefined;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLSpanElement>>;

package/dist/components/modules/tabList/tabList.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const TabList: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/modules/tabList/tabList.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+import { TabList } from "../../../components";
+type Meta = RawMeta<typeof TabList>;
+type Story = RawStory<typeof TabList>;
+declare const meta: Meta;
+export declare const WithHeader: Story;
+export default meta;

package/dist/components/modules/toast/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./toast";
+export * from "./toastBody";
+export * from "./toastMessage";
+export * from "./toastSupplement";
+export * from "./simpleToast";

package/dist/components/modules/toast/simpleToast.d.ts

@@ -0,0 +1,36 @@
+import { ReactNode } from "react";
+/**
+ * ### シンプルなトースト
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const SimpleToast: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    /** */
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    isOpen?: boolean | undefined;
+    /**
+     * 持続時間 (ミリ秒単位)。
+     * `null` を指定すると無限になります。
+     *
+     * ここに指定した時間が経過すると自動的に消滅します。
+     * ただし、ページの閲覧者が閉じるボタンを押した場合、そのときに消滅します。
+     * また、トースト上にカーソルが載っていたりトーストにフォーカスが当たっていたりするときは、自動では消滅しません。
+     * @defaultValue `5000`
+     */
+    duration?: number | null | undefined;
+    /**
+     * 種類。
+     * @defaultValue `"success"`
+     */
+    intent?: "error" | "info" | "success" | undefined;
+    /** */
+    onOpenSet?: ((isOpen: boolean) => unknown) | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLLIElement>>;

package/dist/components/modules/toast/simpleToast.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+import { SimpleToast } from "../../../components";
+type Meta = RawMeta<typeof SimpleToast>;
+type Story = RawStory<typeof SimpleToast>;
+declare const meta: Meta;
+export declare const Success: Story;
+export declare const Error: Story;
+export declare const Info: Story;
+export default meta;

package/dist/components/modules/toast/toast.d.ts

@@ -0,0 +1,74 @@
+import { ReactNode } from "react";
+/**
+ * ### トースト
+ *
+ * #### 構成
+ * 以下のようなコンポーネント構成で利用してください。
+ * - **`Toast`**
+ *   - [`ToastBody`](/docs/modules-Toast-ToastBody--ドキュメント)
+ *     - [`ToastMessage`](/docs/modules-Toast-ToastMessage--ドキュメント)
+ *     - [`ToastSupplement`](/docs/modules-Toast-ToastSupplement--ドキュメント) (任意)
+ *
+ * #### 使い方
+ * 非制御と制御の 2 種類の使い方があります。
+ *
+ * `isOpen` prop を指定しない場合、非制御用法になります。
+ * 非制御用法では、トーストを表示したり消したりする処理を `Toast` コンポーネントに任せます。
+ * このコンポーネントを配置した瞬間にトーストが表示され、`duration` prop に渡された時間が経過すると自動的に消滅します。
+ *
+ * `isOpen` prop を指定した場合、制御用法になります。
+ * 制御用法では、トーストを表示するかどうかを `isOpen` prop を通してユーザー側で指定する必要があります。
+ *
+ * #### `useToast` フック
+ * このコンポーネントを直接利用するよりも、`useToast` フックが返す関数を利用した方が便利なので、こちらの方法でトーストを表示することをお勧めします。
+ * 以下のように `Toast` 要素を引数に渡すことで、簡単にトーストを表示させることができます。
+ *
+ * ```tsx
+ * const dispatchToast = useToast();
+ * dispatchToast(
+ *   <Toast>
+ *     <ToastBody>
+ *       <ToastMessage>
+ *         トーストを表示します。
+ *       </ToastMessage>
+ *     </ToastBody>
+ *   </Toast>
+ * );
+ * ```
+ *
+ * #### 専用コンポーネント
+ * - [`SimpleToast`](/docs/modules-Toast-🎶SimpleToast--ドキュメント) — 構成をシンプルにしたバージョン
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const Toast: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    isOpen?: boolean | undefined;
+    /**
+     * 持続時間 (ミリ秒単位)。
+     * `null` を指定すると無限になります。
+     *
+     * ここに指定した時間が経過すると自動的に消滅します。
+     * ただし、ページの閲覧者が閉じるボタンを押した場合、そのときに消滅します。
+     * また、トースト上にカーソルが載っていたりトーストにフォーカスが当たっていたりするときは、自動では消滅しません。
+     * @defaultValue `5000`
+     */
+    duration?: number | null | undefined;
+    /**
+     * カラースキーム。
+     * @defaultValue `"primary"`
+     */
+    scheme?: "primary" | "secondary" | "blue" | "red" | "green" | "pink" | "yellow" | "purple" | "orange" | "gray" | "gold" | "silver" | "bronze" | undefined;
+    /** */
+    iconNode?: ReactNode;
+    /** */
+    onOpenSet?: ((isOpen: boolean) => unknown) | undefined;
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLLIElement>>;

package/dist/components/modules/toast/toast.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+import { Toast } from "../../../components";
+type Meta = RawMeta<typeof Toast>;
+type Story = RawStory<typeof Toast>;
+declare const meta: Meta;
+export declare const OnlyMessage: Story;
+export declare const MessageAndIcon: Story;
+export declare const WithAll: Story;
+export declare const TestHook: Story;
+export default meta;

package/dist/components/modules/toast/toastBody.d.ts

@@ -0,0 +1,16 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const ToastBody: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    /** */
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/modules/toast/toastMessage.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const ToastMessage: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined; /** */
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLElement>>;

package/dist/components/modules/toast/toastSupplement.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const ToastSupplement: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
+    className?: string | undefined;
+    id?: string | undefined;
+    style?: import("react").CSSProperties | undefined;
+} & {
+    /** */
+    children?: ReactNode;
+    /** */
+    className?: string | undefined;
+} & import("react").RefAttributes<HTMLElement>>;

package/dist/components/modules/toast/toastViewport.d.ts

@@ -0,0 +1,8 @@
+import { FunctionComponent } from "react";
+type ToastViewProps = {};
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const ToastViewport: FunctionComponent<ToastViewProps>;
+export {};

package/dist/components/tests/samples/dialog.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+type Meta = RawMeta;
+type Story = RawStory;
+declare const meta: Meta;
+export declare const Sample: Story;
+export declare const Alert: Story;
+export default meta;

package/dist/components/tests/samples/forms.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+type Meta = RawMeta;
+type Story = RawStory;
+declare const meta: Meta;
+export declare const Register: Story;
+export default meta;

package/dist/components/tests/samples/playableDeckList.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+type Meta = RawMeta;
+type Story = RawStory;
+declare const meta: Meta;
+export declare const SelectDeck: Story;
+export default meta;

package/dist/components/tests/samples/quizList.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta as RawMeta, StoryObj as RawStory } from "@storybook/react";
+type Meta = RawMeta;
+type Story = RawStory;
+declare const meta: Meta;
+export declare const Actual: Story;
+export default meta;

package/dist/components/utils/modalBase/index.d.ts

@@ -0,0 +1 @@
+export * from "./modalBase";

package/dist/components/utils/modalBase/modalBase.d.ts

@@ -0,0 +1,14 @@
+import { FunctionComponent, ReactNode } from "react";
+export type ModalBase = {
+    /** */
+    isOpen: boolean;
+    /** */
+    onClose?: () => unknown;
+    /** */
+    children?: ReactNode;
+};
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const ModalBase: FunctionComponent<ModalBase>;

package/dist/components/utils/storyContainer/index.d.ts

@@ -0,0 +1 @@
+export * from "./storyContainer";

package/dist/components/utils/storyContainer/storyContainer.d.ts

@@ -0,0 +1,12 @@
+import { FunctionComponent, ReactNode } from "react";
+type StoryContainerProps = {
+    width: string;
+    children: ReactNode;
+    className?: string;
+};
+/**
+ * @group React コンポーネント
+ * @category React コンポーネント
+ */
+export declare const StoryContainer: FunctionComponent<StoryContainerProps>;
+export {};

package/dist/contexts/dialog/context.d.ts

@@ -0,0 +1,13 @@
+import { Dispatch, ReactElement, ReactNode, SetStateAction } from "react";
+type DialogContextValue = {
+    open: () => void;
+    close: () => void;
+    setDialogSpec: Dispatch<SetStateAction<{
+        element: ReactElement;
+    } | null>>;
+};
+export declare const dialogContext: import("react").Context<DialogContextValue>;
+export declare const DialogProvider: React.FC<{
+    children: ReactNode;
+}>;
+export {};

package/dist/contexts/dialog/hook.d.ts

@@ -0,0 +1,3 @@
+import { ReactElement } from "react";
+export type OpenDialog = (render: (close: () => void) => ReactElement) => void;
+export declare const useDialog: () => OpenDialog;

package/dist/contexts/footenoteList/context.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+type FootnoteListContextValue = {
+    size: "small" | "medium";
+};
+export declare const footnoteListContext: import("react").Context<FootnoteListContextValue | undefined>;
+export declare const FootnoteListProvider: import("react").Provider<FootnoteListContextValue | undefined>;
+export {};

package/dist/contexts/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dialog/hook";
+export * from "./radioGroup/hook";
+export * from "./toast/hook";

package/dist/contexts/pageProps/context.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { ResolvedPageProps } from "../../components/modules/cardList/cardListAutoHook";
+type PagePropsContextValue = {
+    displayedItems: ReadonlyArray<any>;
+    resolvedPageProps: ResolvedPageProps;
+};
+export declare const pagePropsContext: import("react").Context<PagePropsContextValue>;
+export declare const PagePropsProvider: import("react").Provider<PagePropsContextValue>;
+export {};

package/dist/contexts/radioGroup/context.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+type RadioGroupContextValue = {
+    name: string;
+    value?: string | null;
+    onSet?: (value: string) => unknown;
+};
+export declare const radioGroupContext: import("react").Context<RadioGroupContextValue | undefined>;
+export declare const RadioGroupProvider: import("react").Provider<RadioGroupContextValue | undefined>;
+export {};

package/dist/contexts/radioGroup/hook.d.ts

@@ -0,0 +1,4 @@
+export type UseRadioGroupReturn = {
+    value?: string | null;
+};
+export declare const useRadioGroup: () => UseRadioGroupReturn;

package/dist/contexts/root/context.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { ResponsiveValue } from "../../modules/responsive";
+type RootContextValue = {
+    rootFontSize: ResponsiveValue<string>;
+    smartphoneQuery: string;
+};
+export declare const rootContext: import("react").Context<RootContextValue>;
+export declare const RootProvider: import("react").Provider<RootContextValue>;
+export {};

package/dist/contexts/toast/context.d.ts

@@ -0,0 +1,12 @@
+import { Dispatch, ReactElement, ReactNode, SetStateAction } from "react";
+type ToastContextValue = {
+    setToastSpecs: Dispatch<SetStateAction<Array<{
+        element: ReactElement;
+    }>>>;
+};
+export declare const toastContext: import("react").Context<ToastContextValue>;
+export declare const ToastContextProvider: import("react").Provider<ToastContextValue>;
+export declare const ToastProvider: React.FC<{
+    children: ReactNode;
+}>;
+export {};

package/dist/contexts/toast/hook.d.ts

@@ -0,0 +1,3 @@
+import { ReactElement } from "react";
+export type DispatchToast = (element: ReactElement) => void;
+export declare const useToast: () => DispatchToast;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./components";
+export * from "./contexts";
+export * from "./modules/color";
+export * from "./modules/data";
+export * from "./modules/message";
+export * from "./modules/responsive";
+export * from "./modules/subject";
+export * from "./modules/translation";