@necto-react/types 2.3.0 → 2.4.0

package/dist/index.d.mts

@@ -222,4 +222,65 @@ type SlottedContextValue<T, E = never> =
   | null
   | undefined;
 
-export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SlottedContextValue, StyleRenderProps };
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/** Selection mode for a collection. */
+type SelectionMode = 'none' | 'single' | 'multiple';
+
+/** Focus strategy when auto-focusing. */
+type FocusStrategy = 'first' | 'last';
+
+/**
+ * Interface for managing selection state in a collection.
+ */
+interface SelectionManager {
+  /** The currently focused key. */
+  readonly focusedKey: (string | number) | null;
+  /** Set the focused key. */
+  setFocusedKey(
+    key: (string | number) | null,
+    childFocus?: FocusStrategy
+  ): void;
+  /** Whether the collection is focused. */
+  readonly isFocused: boolean;
+  /** Set whether the collection is focused. */
+  setFocused(isFocused: boolean): void;
+  /** The set of selected keys. */
+  readonly selectedKeys: Set<string | number>;
+  /** The selection mode. */
+  readonly selectionMode: SelectionMode;
+  /** Replace selection with a single key. */
+  replaceSelection(key: string | number): void;
+  /** Extend selection to include a key. */
+  extendSelection(key: string | number): void;
+  /** Toggle selection of a key. */
+  toggleSelection(key: string | number): void;
+  /** Select all items. */
+  selectAll(): void;
+  /** Clear all selection. */
+  clearSelection(): void;
+  /** Check if a key is selected. */
+  isSelected(key: string | number): boolean;
+  /** Check if a key is disabled. */
+  isDisabled?(key: string | number): boolean;
+  /** Check if a key is a link. */
+  isLink?(key: string | number): boolean;
+  /** Get props for an item. */
+  getItemProps?(
+    key: string | number
+  ): { href?: string; routerOptions?: unknown } | undefined;
+  /** Whether the user can select an item. */
+  canSelectItem?(key: string | number): boolean;
+  /** The first selected key. */
+  readonly firstSelectedKey?: (string | number) | null;
+  /** The last selected key. */
+  readonly lastSelectedKey?: (string | number) | null;
+}
+
+export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusStrategy, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SelectionManager, SelectionMode, SlottedContextValue, StyleRenderProps };

package/dist/index.d.ts

@@ -222,4 +222,65 @@ type SlottedContextValue<T, E = never> =
   | null
   | undefined;
 
-export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SlottedContextValue, StyleRenderProps };
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/** Selection mode for a collection. */
+type SelectionMode = 'none' | 'single' | 'multiple';
+
+/** Focus strategy when auto-focusing. */
+type FocusStrategy = 'first' | 'last';
+
+/**
+ * Interface for managing selection state in a collection.
+ */
+interface SelectionManager {
+  /** The currently focused key. */
+  readonly focusedKey: (string | number) | null;
+  /** Set the focused key. */
+  setFocusedKey(
+    key: (string | number) | null,
+    childFocus?: FocusStrategy
+  ): void;
+  /** Whether the collection is focused. */
+  readonly isFocused: boolean;
+  /** Set whether the collection is focused. */
+  setFocused(isFocused: boolean): void;
+  /** The set of selected keys. */
+  readonly selectedKeys: Set<string | number>;
+  /** The selection mode. */
+  readonly selectionMode: SelectionMode;
+  /** Replace selection with a single key. */
+  replaceSelection(key: string | number): void;
+  /** Extend selection to include a key. */
+  extendSelection(key: string | number): void;
+  /** Toggle selection of a key. */
+  toggleSelection(key: string | number): void;
+  /** Select all items. */
+  selectAll(): void;
+  /** Clear all selection. */
+  clearSelection(): void;
+  /** Check if a key is selected. */
+  isSelected(key: string | number): boolean;
+  /** Check if a key is disabled. */
+  isDisabled?(key: string | number): boolean;
+  /** Check if a key is a link. */
+  isLink?(key: string | number): boolean;
+  /** Get props for an item. */
+  getItemProps?(
+    key: string | number
+  ): { href?: string; routerOptions?: unknown } | undefined;
+  /** Whether the user can select an item. */
+  canSelectItem?(key: string | number): boolean;
+  /** The first selected key. */
+  readonly firstSelectedKey?: (string | number) | null;
+  /** The last selected key. */
+  readonly lastSelectedKey?: (string | number) | null;
+}
+
+export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusStrategy, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SelectionManager, SelectionMode, SlottedContextValue, StyleRenderProps };

package/dist/index.js

@@ -1 +1 @@
-"use strict";var r=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var s=(e,o,m,t)=>{if(o&&typeof o=="object"||typeof o=="function")for(let p of x(o))!y.call(e,p)&&p!==m&&r(e,p,{get:()=>o[p],enumerable:!(t=f(o,p))||t.enumerable});return e};var n=e=>s(r({},"__esModule",{value:!0}),e);var a={};module.exports=n(a);
+"use strict";var r=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var s=(o,e,m,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let p of x(e))!y.call(o,p)&&p!==m&&r(o,p,{get:()=>e[p],enumerable:!(t=f(e,p))||t.enumerable});return o};var n=o=>s(r({},"__esModule",{value:!0}),o);var c={};module.exports=n(c);

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@necto-react/types",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "",
+  "scripts": {
+    "build": "tsup --minify"
+  },
   "files": [
     "dist",
     "README.md"
@@ -20,8 +23,5 @@
   "peerDependencies": {
     "react": "^19.1.0",
     "react-dom": "^19.1.0"
-  },
-  "scripts": {
-    "build": "tsup --minify"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) Corinvo, LLC. and affiliates. All rights reserved.
-
-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.