@zag-js/tabs 0.1.9 → 0.1.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Chakra UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,3 +1,115 @@
-export { connect } from "./tabs.connect";
-export { machine } from "./tabs.machine";
-export type { UserDefinedContext as Context } from "./tabs.types";
+import { RequiredBy, DirectionProperty, CommonProperties, Context, PropTypes, NormalizeProps } from '@zag-js/types';
+import * as _zag_js_core from '@zag-js/core';
+import { StateMachine } from '@zag-js/core';
+
+declare type IntlMessages = {
+    tablistLabel?: string;
+    deleteLabel?(value: string): string;
+};
+declare type ElementIds = Partial<{
+    root: string;
+    trigger: string;
+    triggerGroup: string;
+    contentGroup: string;
+    content: string;
+}>;
+declare type PublicContext = DirectionProperty & CommonProperties & {
+    /**
+     * The ids of the elements in the tabs. Useful for composition.
+     */
+    ids?: ElementIds;
+    /**
+     * Specifies the localized strings that identifies the accessibility elements and their states
+     */
+    messages: IntlMessages;
+    /**
+     * Whether the keyboard navigation will loop from last tab to first, and vice versa.
+     * @default true
+     */
+    loop: boolean;
+    /**
+     * Whether the indicator is rendered.
+     */
+    isIndicatorRendered: boolean;
+    /**
+     * The selected tab id
+     */
+    value: string | null;
+    /**
+     * The orientation of the tabs. Can be `horizontal` or `vertical`
+     * - `horizontal`: only left and right arrow key navigation will work.
+     * - `vertical`: only up and down arrow key navigation will work.
+     *
+     * @default "horizontal"
+     */
+    orientation?: "horizontal" | "vertical";
+    /**
+     * The activation mode of the tabs. Can be `manual` or `automatic`
+     * - `manual`: Tabs are activated when clicked or press `enter` key.
+     * - `automatic`: Tabs are activated when receiving focus
+     * @default "automatic"
+     */
+    activationMode?: "manual" | "automatic";
+    /**
+     * Callback to be called when the selected/active tab changes
+     */
+    onChange?: (details: {
+        value: string | null;
+    }) => void;
+    /**
+     * Callback to be called when the focused tab changes
+     */
+    onFocus?: (details: {
+        value: string | null;
+    }) => void;
+    /**
+     * Callback to be called when a tab's close button is clicked
+     */
+    onDelete?: (details: {
+        value: string;
+    }) => void;
+};
+declare type UserDefinedContext = RequiredBy<PublicContext, "id">;
+declare type ComputedContext = Readonly<{
+    /**
+     * @computed
+     * Whether the tab is in the horizontal orientation
+     */
+    isHorizontal: boolean;
+    /**
+     * @computed
+     * Whether the tab is in the vertical orientation
+     */
+    isVertical: boolean;
+}>;
+declare type PrivateContext = Context<{}>;
+declare type MachineContext = PublicContext & ComputedContext & PrivateContext;
+declare type MachineState = {
+    value: "unknown" | "idle" | "focused";
+};
+declare type State = StateMachine.State<MachineContext, MachineState>;
+declare type Send = StateMachine.Send<StateMachine.AnyEventObject>;
+declare type TabProps = {
+    value: string;
+    disabled?: boolean;
+};
+
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): {
+    value: string | null;
+    focusedValue: string | null;
+    previousValues: string[];
+    setValue(value: string): void;
+    rootProps: T["element"];
+    triggerGroupProps: T["element"];
+    getTriggerProps(props: TabProps): T["button"];
+    contentGroupProps: T["element"];
+    getContentProps({ value }: {
+        value: string;
+    }): T["element"];
+    getDeleteButtonProps({ value, disabled }: TabProps): T["button"];
+    indicatorProps: T["element"];
+};
+
+declare function machine(ctx: UserDefinedContext): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
+
+export { UserDefinedContext as Context, connect, machine };