@baseline-ui/core 0.59.0 → 0.60.1

package/dist/react-stately.d.ts

@@ -0,0 +1,319 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+
+type Selection = 'all' | Set<Key>;
+
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+type Key = string | number;
+
+/** A list of supported color formats. */
+type ColorFormat = 'hex' | 'hexa' | 'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hsb' | 'hsba';
+type ColorSpace = 'rgb' | 'hsl' | 'hsb';
+/** A list of color channels. */
+type ColorChannel = 'hue' | 'saturation' | 'brightness' | 'lightness' | 'red' | 'green' | 'blue' | 'alpha';
+type ColorAxes = {
+    xChannel: ColorChannel;
+    yChannel: ColorChannel;
+    zChannel: ColorChannel;
+};
+interface ColorChannelRange {
+    /** The minimum value of the color channel. */
+    minValue: number;
+    /** The maximum value of the color channel. */
+    maxValue: number;
+    /** The step value of the color channel, used when incrementing and decrementing. */
+    step: number;
+    /** The page step value of the color channel, used when incrementing and decrementing. */
+    pageSize: number;
+}
+/** Represents a color value. */
+interface Color {
+    /** Converts the color to the given color format, and returns a new Color object. */
+    toFormat(format: ColorFormat): Color;
+    /** Converts the color to a string in the given format. */
+    toString(format?: ColorFormat | 'css'): string;
+    /** Returns a duplicate of the color value. */
+    clone(): Color;
+    /** Converts the color to hex, and returns an integer representation. */
+    toHexInt(): number;
+    /**
+     * Returns the numeric value for a given channel.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    getChannelValue(channel: ColorChannel): number;
+    /**
+     * Sets the numeric value for a given channel, and returns a new Color object.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    withChannelValue(channel: ColorChannel, value: number): Color;
+    /**
+     * Returns the minimum, maximum, and step values for a given channel.
+     */
+    getChannelRange(channel: ColorChannel): ColorChannelRange;
+    /**
+     * Returns a localized color channel name for a given channel and locale,
+     * for use in visual or accessibility labels.
+     */
+    getChannelName(channel: ColorChannel, locale: string): string;
+    /**
+     * Returns the number formatting options for the given channel.
+     */
+    getChannelFormatOptions(channel: ColorChannel): Intl.NumberFormatOptions;
+    /**
+     * Formats the numeric value for a given channel for display according to the provided locale.
+     */
+    formatChannelValue(channel: ColorChannel, locale: string): string;
+    /**
+     * Returns the color space, 'rgb', 'hsb' or 'hsl', for the current color.
+     */
+    getColorSpace(): ColorSpace;
+    /**
+     * Returns the color space axes, xChannel, yChannel, zChannel.
+     */
+    getColorSpaceAxes(xyChannels: {
+        xChannel?: ColorChannel;
+        yChannel?: ColorChannel;
+    }): ColorAxes;
+    /**
+     * Returns an array of the color channels within the current color space space.
+     */
+    getColorChannels(): [ColorChannel, ColorChannel, ColorChannel];
+    /**
+     * Returns a localized name for the color, for use in visual or accessibility labels.
+     */
+    getColorName(locale: string): string;
+    /**
+     * Returns a localized name for the hue, for use in visual or accessibility labels.
+     */
+    getHueName(locale: string): string;
+}
+
+interface ListOptions<T> {
+    /** Initial items in the list. */
+    initialItems?: T[];
+    /** The keys for the initially selected items. */
+    initialSelectedKeys?: 'all' | Iterable<Key>;
+    /** The initial text to filter the list by. */
+    initialFilterText?: string;
+    /** A function that returns a unique key for an item object. */
+    getKey?: (item: T) => Key;
+    /** A function that returns whether a item matches the current filter text. */
+    filter?: (item: T, filterText: string) => boolean;
+}
+interface ListData<T> {
+    /** The items in the list. */
+    items: T[];
+    /** The keys of the currently selected items in the list. */
+    selectedKeys: Selection;
+    /** Sets the selected keys. */
+    setSelectedKeys(keys: Selection): void;
+    /** Adds the given keys to the current selected keys. */
+    addKeysToSelection(keys: Selection): void;
+    /** Removes the given keys from the current selected keys. */
+    removeKeysFromSelection(keys: Selection): void;
+    /** The current filter text. */
+    filterText: string;
+    /** Sets the filter text. */
+    setFilterText(filterText: string): void;
+    /**
+     * Gets an item from the list by key.
+     * @param key - The key of the item to retrieve.
+     */
+    getItem(key: Key): T | undefined;
+    /**
+     * Inserts items into the list at the given index.
+     * @param index - The index to insert into.
+     * @param values - The values to insert.
+     */
+    insert(index: number, ...values: T[]): void;
+    /**
+     * Inserts items into the list before the item at the given key.
+     * @param key - The key of the item to insert before.
+     * @param values - The values to insert.
+     */
+    insertBefore(key: Key, ...values: T[]): void;
+    /**
+     * Inserts items into the list after the item at the given key.
+     * @param key - The key of the item to insert after.
+     * @param values - The values to insert.
+     */
+    insertAfter(key: Key, ...values: T[]): void;
+    /**
+     * Appends items to the list.
+     * @param values - The values to insert.
+     */
+    append(...values: T[]): void;
+    /**
+     * Prepends items to the list.
+     * @param value - The value to insert.
+     */
+    prepend(...values: T[]): void;
+    /**
+     * Removes items from the list by their keys.
+     * @param keys - The keys of the item to remove.
+     */
+    remove(...keys: Key[]): void;
+    /**
+     * Removes all items from the list that are currently
+     * in the set of selected items.
+     */
+    removeSelectedItems(): void;
+    /**
+     * Moves an item within the list.
+     * @param key - The key of the item to move.
+     * @param toIndex - The index to move the item to.
+     */
+    move(key: Key, toIndex: number): void;
+    /**
+     * Moves one or more items before a given key.
+     * @param key - The key of the item to move the items before.
+     * @param keys - The keys of the items to move.
+     */
+    moveBefore(key: Key, keys: Iterable<Key>): void;
+    /**
+     * Moves one or more items after a given key.
+     * @param key - The key of the item to move the items after.
+     * @param keys - The keys of the items to move.
+     */
+    moveAfter(key: Key, keys: Iterable<Key>): void;
+    /**
+     * Updates an item in the list.
+     * @param key - The key of the item to update.
+     * @param newValue - The new value for the item, or a function that returns the new value based on the previous value.
+     */
+    update(key: Key, newValue: T | ((prev: T) => T)): void;
+}
+/**
+ * Manages state for an immutable list data structure, and provides convenience methods to
+ * update the data over time.
+ */
+declare function useListData<T>(options: ListOptions<T>): ListData<T>;
+
+interface TreeOptions<T extends object> {
+    /** Initial root items in the tree. */
+    initialItems?: T[];
+    /** The keys for the initially selected items. */
+    initialSelectedKeys?: Iterable<Key>;
+    /** A function that returns a unique key for an item object. */
+    getKey?: (item: T) => Key;
+    /** A function that returns the children for an item object. */
+    getChildren?: (item: T) => T[];
+}
+interface TreeNode<T extends object> {
+    /** A unique key for the tree node. */
+    key: Key;
+    /** The key of the parent node. */
+    parentKey?: Key | null;
+    /** The value object for the tree node. */
+    value: T;
+    /** Children of the tree node. */
+    children: TreeNode<T>[] | null;
+}
+interface TreeData<T extends object> {
+    /** The root nodes in the tree. */
+    items: TreeNode<T>[];
+    /** The keys of the currently selected items in the tree. */
+    selectedKeys: Set<Key>;
+    /** Sets the selected keys. */
+    setSelectedKeys(keys: Set<Key>): void;
+    /**
+     * Gets a node from the tree by key.
+     * @param key - The key of the item to retrieve.
+     */
+    getItem(key: Key): TreeNode<T> | undefined;
+    /**
+     * Inserts an item into a parent node as a child.
+     * @param parentKey - The key of the parent item to insert into. `null` for the root.
+     * @param index - The index within the parent to insert into.
+     * @param value - The value to insert.
+     */
+    insert(parentKey: Key | null, index: number, ...values: T[]): void;
+    /**
+     * Inserts items into the list before the item at the given key.
+     * @param key - The key of the item to insert before.
+     * @param values - The values to insert.
+     */
+    insertBefore(key: Key, ...values: T[]): void;
+    /**
+     * Inserts items into the list after the item at the given key.
+     * @param key - The key of the item to insert after.
+     * @param values - The values to insert.
+     */
+    insertAfter(key: Key, ...values: T[]): void;
+    /**
+     * Appends an item into a parent node as a child.
+     * @param parentKey - The key of the parent item to insert into. `null` for the root.
+     * @param value - The value to insert.
+     */
+    append(parentKey: Key | null, ...values: T[]): void;
+    /**
+     * Prepends an item into a parent node as a child.
+     * @param parentKey - The key of the parent item to insert into. `null` for the root.
+     * @param value - The value to insert.
+     */
+    prepend(parentKey: Key | null, ...value: T[]): void;
+    /**
+     * Removes an item from the tree by its key.
+     * @param key - The key of the item to remove.
+     */
+    remove(...keys: Key[]): void;
+    /**
+     * Removes all items from the tree that are currently
+     * in the set of selected items.
+     */
+    removeSelectedItems(): void;
+    /**
+     * Moves an item within the tree.
+     * @param key - The key of the item to move.
+     * @param toParentKey - The key of the new parent to insert into. `null` for the root.
+     * @param index - The index within the new parent to insert at.
+     */
+    move(key: Key, toParentKey: Key | null, index: number): void;
+    /**
+     * Moves one or more items before a given key.
+     * @param key - The key of the item to move the items before.
+     * @param keys - The keys of the items to move.
+     */
+    moveBefore(key: Key, keys: Iterable<Key>): void;
+    /**
+     * Moves one or more items after a given key.
+     * @param key - The key of the item to move the items after.
+     * @param keys - The keys of the items to move.
+     */
+    moveAfter(key: Key, keys: Iterable<Key>): void;
+    /**
+     * Updates an item in the tree.
+     * @param key - The key of the item to update.
+     * @param newValue - The new value for the item.
+     */
+    update(key: Key, newValue: T): void;
+}
+/**
+ * Manages state for an immutable tree data structure, and provides convenience methods to
+ * update the data over time.
+ */
+declare function useTreeData<T extends object>(options: TreeOptions<T>): TreeData<T>;
+
+export { useListData, useTreeData };
+export type { Color, ListData, TreeData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baseline-ui/core",
-  "version": "0.59.0",
+  "version": "0.60.1",
   "description": "Baseline UI is a set of accessible components and tools for building accessible, customizable, production-ready user interfaces",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -36,9 +36,9 @@
     "slate-hyperscript": "^0.100.0",
     "tailwind-merge": "^3.5.0",
     "use-sync-external-store": "1.6.0",
-    "@baseline-ui/css": "0.59.0",
-    "@baseline-ui/icons": "0.59.0",
-    "@baseline-ui/tokens": "0.59.0"
+    "@baseline-ui/css": "0.60.1",
+    "@baseline-ui/icons": "0.60.1",
+    "@baseline-ui/tokens": "0.60.1"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -49,15 +49,15 @@
     "@types/dompurify": "3.2.0",
     "@types/markdown-it": "^14.1.2",
     "@vanilla-extract/recipes": "0.5.7",
-    "@baseline-ui/translations": "0.59.0"
+    "@baseline-ui/translations": "0.60.1"
   },
   "license": "SEE LICENSE IN https://pspdfkit.com/legal/License.pdf",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --clean --dts --minify --treeshake",
-    "build:dts": "pnpx rollup -c rollup.config.js",
+    "build": "tsup src/index.ts --format cjs,esm --clean --minify --treeshake --no-dts && pnpm run build:dts",
+    "build:dts": "rollup -c rollup.config.js",
     "build:docs": "typedoc --useCodeBlocks --enumMembersFormat table --hidePageTitle --parametersFormat table --propertiesFormat table --hidePageHeader --indexFormat table --typeDeclarationFormat table --hideBreadcrumbs --outputFileStrategy modules",
     "acknowledgements": "pnpm-licenses generate-disclaimer --prod --output-file=Acknowledgements.md"
   }