@gamecrafters/base-ui 0.0.39 → 0.0.41

package/build/components/index.d.ts

@@ -59,6 +59,7 @@ export * from "./highlight";
 export * from "./hover-card";
 export * from "./icon-button";
 export * from "./image";
+export * from "./inline-edit";
 export * from "./inline-message";
 export * from "./json-tree-view";
 export * from "./keybinding-hint";

package/build/components/inline-edit/InlineEdit.d.ts

@@ -0,0 +1,8 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof import("./InlineEdit.types").UseInlineEditProps> & import("./InlineEdit.types").UseInlineEditProps & {
+    size?: import("..").TextInputSize;
+    block?: boolean;
+    contrast?: boolean;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEdit.types.d.ts

@@ -0,0 +1,116 @@
+import type * as React from "react";
+import type { PolymorphicProps } from "../../utilities/polymorphic";
+import type { ButtonSize, ButtonVariant, ButtonVisual } from "../button";
+import type { TextInputSize } from "../text-input/TextInput.types";
+export type InlineEditActivationMode = "focus" | "click" | "dblclick" | "none";
+export type InlineEditSubmitMode = "enter" | "blur" | "both" | "none";
+export type InlineEditPlaceholder = string | {
+    edit: string;
+    preview: string;
+};
+export type InlineEditInputElement = "input" | "textarea";
+export type InlineEditIds = {
+    root?: string;
+    label?: string;
+    area?: string;
+    input?: string;
+    preview?: string;
+    control?: string;
+    editTrigger?: string;
+    submitTrigger?: string;
+    cancelTrigger?: string;
+};
+export type UseInlineEditProps = {
+    value?: string;
+    defaultValue?: string;
+    edit?: boolean;
+    defaultEdit?: boolean;
+    activationMode?: InlineEditActivationMode;
+    submitMode?: InlineEditSubmitMode;
+    selectOnFocus?: boolean;
+    placeholder?: InlineEditPlaceholder;
+    maxLength?: number;
+    autoResize?: boolean;
+    disabled?: boolean;
+    readOnly?: boolean;
+    required?: boolean;
+    invalid?: boolean;
+    name?: string;
+    form?: string;
+    id?: string;
+    ids?: InlineEditIds;
+    returnFocusRef?: React.RefObject<HTMLElement | null>;
+    onValueChange?: (value: string) => void;
+    onValueCommit?: (value: string) => void;
+    onValueRevert?: (value: string) => void;
+    onEditChange?: (edit: boolean) => void;
+};
+export type UseInlineEditReturn = {
+    editing: boolean;
+    empty: boolean;
+    value: string;
+    valueText: string;
+    placeholder?: string;
+    activationMode: InlineEditActivationMode;
+    autoResize: boolean;
+    maxLength?: number;
+    disabled: boolean;
+    readOnly: boolean;
+    required: boolean;
+    invalid: boolean;
+    name?: string;
+    form?: string;
+    ids: Required<InlineEditIds>;
+    describedBy?: string;
+    setValue: (value: string) => void;
+    clearValue: () => void;
+    edit: () => void;
+    submit: () => void;
+    cancel: () => void;
+    focus: () => void;
+    rootRef: React.RefObject<HTMLDivElement | null>;
+    handleInputChange: (event: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
+    handleInputKeyDown: (event: React.KeyboardEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
+    handlePreviewFocus: () => void;
+    handlePreviewClick: () => void;
+    handlePreviewDoubleClick: () => void;
+    handlePreviewKeyDown: (event: React.KeyboardEvent<HTMLElement>) => void;
+};
+type InlineEditFieldProps = {
+    size?: TextInputSize;
+    block?: boolean;
+    contrast?: boolean;
+    className?: string;
+};
+export type InlineEditProps = Omit<React.ComponentPropsWithoutRef<"div">, keyof UseInlineEditProps> & UseInlineEditProps & InlineEditFieldProps;
+export type InlineEditRootProviderProps = Omit<React.ComponentPropsWithoutRef<"div">, "defaultValue"> & InlineEditFieldProps & {
+    value: UseInlineEditReturn;
+};
+export type InlineEditLabelProps = React.ComponentPropsWithoutRef<"label"> & {
+    visuallyHidden?: boolean;
+    className?: string;
+};
+export type InlineEditAreaProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+export type InlineEditInputProps<As extends InlineEditInputElement = "input"> = Omit<PolymorphicProps<As, "input", {
+    className?: string;
+}>, "value" | "defaultValue">;
+export type InlineEditPreviewProps<As extends React.ElementType = "span"> = PolymorphicProps<As, "span", {
+    className?: string;
+}>;
+export type InlineEditControlProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+type InlineEditTriggerProps = Omit<React.ComponentPropsWithoutRef<"button">, "type" | "aria-label" | "aria-labelledby"> & {
+    variant?: ButtonVariant;
+    size?: ButtonSize;
+    icon?: ButtonVisual;
+    label?: string;
+    className?: string;
+};
+export type InlineEditEditTriggerProps = InlineEditTriggerProps;
+export type InlineEditSubmitTriggerProps = InlineEditTriggerProps;
+export type InlineEditCancelTriggerProps = InlineEditTriggerProps;
+export type InlineEditContextValue = Partial<UseInlineEditReturn> & Omit<InlineEditFieldProps, "className">;
+export {};

package/build/components/inline-edit/InlineEditArea.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditCancelTrigger.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+    variant?: import("..").ButtonVariant;
+    size?: import("..").ButtonSize;
+    icon?: import("..").ButtonVisual;
+    label?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditContext.d.ts

@@ -0,0 +1,10 @@
+import type { InlineEditContextValue } from "./InlineEdit.types";
+export declare const InlineEditContext: import("react").Context<InlineEditContextValue>;
+export declare const useInlineEditContext: () => InlineEditContextValue;
+export declare const getStateAttributes: ({ editing, disabled, readOnly, required, invalid, }: InlineEditContextValue) => {
+    "data-editing": true | undefined;
+    "data-disabled": true | undefined;
+    "data-readonly": true | undefined;
+    "data-required": true | undefined;
+    "data-invalid": true | undefined;
+};

package/build/components/inline-edit/InlineEditControl.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditEditTrigger.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+    variant?: import("..").ButtonVariant;
+    size?: import("..").ButtonSize;
+    icon?: import("..").ButtonVisual;
+    label?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditInput.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { InlineEditInputElement, InlineEditInputProps } from "./InlineEdit.types";
+declare const _default: <As extends InlineEditInputElement = "input">(props: InlineEditInputProps<As> & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditLabel.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>, "ref"> & {
+    visuallyHidden?: boolean;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditPreview.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+declare const _default: <As extends React.ElementType = "span">(props: import("../../utilities/polymorphic").DistributiveOmit<React.ComponentPropsWithRef<React.ElementType extends As ? "span" : As> & {
+    className?: string;
+}, "as"> & {
+    as?: As | undefined;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditRootProvider.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "defaultValue"> & {
+    size?: import("..").TextInputSize;
+    block?: boolean;
+    contrast?: boolean;
+    className?: string;
+} & {
+    value: import("./InlineEdit.types").UseInlineEditReturn;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/InlineEditSubmitTrigger.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+    variant?: import("..").ButtonVariant;
+    size?: import("..").ButtonSize;
+    icon?: import("..").ButtonVisual;
+    label?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/inline-edit/index.d.ts

@@ -0,0 +1,71 @@
+import InlineEditArea from "./InlineEditArea";
+import InlineEditCancelTrigger from "./InlineEditCancelTrigger";
+import InlineEditControl from "./InlineEditControl";
+import InlineEditEditTrigger from "./InlineEditEditTrigger";
+import InlineEditInput from "./InlineEditInput";
+import InlineEditLabel from "./InlineEditLabel";
+import InlineEditPreview from "./InlineEditPreview";
+import InlineEditRootProvider from "./InlineEditRootProvider";
+import InlineEditSubmitTrigger from "./InlineEditSubmitTrigger";
+export declare const InlineEdit: ((props: Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof import("./InlineEdit.types").UseInlineEditProps> & import("./InlineEdit.types").UseInlineEditProps & {
+    size?: import("..").TextInputSize;
+    block?: boolean;
+    contrast?: boolean;
+    className?: string;
+} & import("react").RefAttributes<any>) => React.ReactNode) & {
+    Root: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof import("./InlineEdit.types").UseInlineEditProps> & import("./InlineEdit.types").UseInlineEditProps & {
+        size?: import("..").TextInputSize;
+        block?: boolean;
+        contrast?: boolean;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    RootProvider: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "defaultValue"> & {
+        size?: import("..").TextInputSize;
+        block?: boolean;
+        contrast?: boolean;
+        className?: string;
+    } & {
+        value: import("./InlineEdit.types").UseInlineEditReturn;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Label: (props: Omit<import("react").DetailedHTMLProps<import("react").LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>, "ref"> & {
+        visuallyHidden?: boolean;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Area: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Input: <As extends import("./InlineEdit.types").InlineEditInputElement = "input">(props: import("./InlineEdit.types").InlineEditInputProps<As> & import("react").RefAttributes<any>) => React.ReactNode;
+    Preview: <As extends React.ElementType = "span">(props: import("../../utilities/polymorphic").DistributiveOmit<import("react").ComponentPropsWithRef<import("react").ElementType extends As ? "span" : As> & {
+        className?: string;
+    }, "as"> & {
+        as?: As | undefined;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Control: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    EditTrigger: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+        variant?: import("..").ButtonVariant;
+        size?: import("..").ButtonSize;
+        icon?: import("..").ButtonVisual;
+        label?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    SubmitTrigger: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+        variant?: import("..").ButtonVariant;
+        size?: import("..").ButtonSize;
+        icon?: import("..").ButtonVisual;
+        label?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    CancelTrigger: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "type" | "aria-label" | "aria-labelledby"> & {
+        variant?: import("..").ButtonVariant;
+        size?: import("..").ButtonSize;
+        icon?: import("..").ButtonVisual;
+        label?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+};
+export { InlineEditRootProvider, InlineEditLabel, InlineEditArea, InlineEditInput, InlineEditPreview, InlineEditControl, InlineEditEditTrigger, InlineEditSubmitTrigger, InlineEditCancelTrigger, };
+export { InlineEditContext, useInlineEditContext } from "./InlineEditContext";
+export { useInlineEdit } from "./useInlineEdit";
+export * from "./InlineEdit.types";

package/build/components/inline-edit/useInlineEdit.d.ts

@@ -0,0 +1,2 @@
+import type { UseInlineEditProps, UseInlineEditReturn } from "./InlineEdit.types";
+export declare const useInlineEdit: (props?: UseInlineEditProps) => UseInlineEditReturn;