@zag-js/types 0.20.0 → 0.22.0

package/dist/index.d.mts

@@ -1176,6 +1176,13 @@ interface DirectionProperty {
      */
     dir?: "ltr" | "rtl";
 }
+interface LocaleProperties extends DirectionProperty {
+    /**
+     * The current locale. Based on the BCP 47 definition.
+     * @default "en-US"
+     */
+    locale?: string;
+}
 interface CommonProperties {
     /**
      * The unique identifier of the machine.
@@ -1204,4 +1211,4 @@ interface RootProperties {
 type Context<T> = T & RootProperties;
 type Style = JSX.CSSProperties;
 
-export { CommonProperties, Context, Direction, DirectionProperty, JSX, MaybeElement, NormalizeProps, Orientation, OrientationProperty, PropTypes, RequiredBy, RootProperties, Style, createNormalizer };
+export { CommonProperties, Context, Direction, DirectionProperty, JSX, LocaleProperties, MaybeElement, NormalizeProps, Orientation, OrientationProperty, PropTypes, RequiredBy, RootProperties, Style, createNormalizer };

package/dist/index.d.ts

@@ -1176,6 +1176,13 @@ interface DirectionProperty {
      */
     dir?: "ltr" | "rtl";
 }
+interface LocaleProperties extends DirectionProperty {
+    /**
+     * The current locale. Based on the BCP 47 definition.
+     * @default "en-US"
+     */
+    locale?: string;
+}
 interface CommonProperties {
     /**
      * The unique identifier of the machine.
@@ -1204,4 +1211,4 @@ interface RootProperties {
 type Context<T> = T & RootProperties;
 type Style = JSX.CSSProperties;
 
-export { CommonProperties, Context, Direction, DirectionProperty, JSX, MaybeElement, NormalizeProps, Orientation, OrientationProperty, PropTypes, RequiredBy, RootProperties, Style, createNormalizer };
+export { CommonProperties, Context, Direction, DirectionProperty, JSX, LocaleProperties, MaybeElement, NormalizeProps, Orientation, OrientationProperty, PropTypes, RequiredBy, RootProperties, Style, createNormalizer };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/prop-types.ts"],"sourcesContent":["import type { JSX } from \"./jsx\"\n\nexport type RequiredBy<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>\n\nexport type Direction = \"ltr\" | \"rtl\"\n\nexport type Orientation = \"horizontal\" | \"vertical\"\n\nexport type MaybeElement<T extends HTMLElement = HTMLElement> = T | null\n\nexport interface OrientationProperty {\n  /**\n   * The orientation of the element.\n   * @default \"horizontal\"\n   */\n  orientation?: Orientation\n}\n\nexport interface DirectionProperty {\n  /**\n   * The document's text/writing direction.\n   * @default \"ltr\"\n   */\n  dir?: \"ltr\" | \"rtl\"\n}\n\nexport interface CommonProperties {\n  /**\n   * The unique identifier of the machine.\n   */\n  id: string\n  /**\n   * A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.\n   */\n  getRootNode?: () => ShadowRoot | Document | Node\n}\n\nexport interface RootProperties {\n  /**\n   * The owner document of the machine.\n   */\n  doc?: Document\n  /**\n   * The root node of the machine. Useful for shadow DOM.\n   */\n  rootNode?: ShadowRoot\n  /**\n   * The related target when the element is blurred.\n   * Used as a polyfill for `e.relatedTarget`\n   */\n  pointerdownNode?: HTMLElement | null\n}\n\nexport type Context<T> = T & RootProperties\n\nexport type Style = JSX.CSSProperties\n\nexport * from \"./prop-types\"\nexport type { JSX }\n","import type { JSX } from \"./jsx\"\n\ntype Dict<T = any> = Record<string, T>\n\ntype Booleanish = boolean | \"true\" | \"false\"\n\ntype DataAttr = {\n  \"data-selected\"?: Booleanish\n  \"data-expanded\"?: Booleanish\n  \"data-highlighted\"?: Booleanish\n  \"data-readonly\"?: Booleanish\n  \"data-indeterminate\"?: Booleanish\n  \"data-invalid\"?: Booleanish\n  \"data-hover\"?: Booleanish\n  \"data-active\"?: Booleanish\n  \"data-focus\"?: Booleanish\n  \"data-disabled\"?: Booleanish\n  \"data-open\"?: Booleanish\n  \"data-checked\"?: Booleanish\n  \"data-pressed\"?: Booleanish\n  \"data-complete\"?: Booleanish\n  \"data-empty\"?: Booleanish\n  \"data-placeholder-shown\"?: Booleanish\n  \"data-half\"?: Booleanish\n  \"data-scope\"?: string\n\n  \"data-uid\"?: string\n  \"data-name\"?: string\n  \"data-ownedby\"?: string\n  \"data-type\"?: string\n  \"data-valuetext\"?: string\n  \"data-placement\"?: string\n  \"data-controls\"?: string\n  \"data-part\"?: string\n  \"data-label\"?: string\n  \"data-state\"?: string | null\n  \"data-value\"?: string | number\n\n  \"data-orientation\"?: \"horizontal\" | \"vertical\"\n\n  \"data-count\"?: number\n  \"data-index\"?: number\n} & {\n  [key in `data-${string}`]?: string | number | Booleanish\n}\n\nexport type PropTypes<T = Dict> = Record<\n  \"button\" | \"label\" | \"input\" | \"img\" | \"output\" | \"element\" | \"select\" | \"style\",\n  T\n>\n\nexport type NormalizeProps<T extends PropTypes> = {\n  [K in keyof T]: (props: K extends keyof JSX.IntrinsicElements ? DataAttr & JSX.IntrinsicElements[K] : never) => T[K]\n} & {\n  element(props: DataAttr & JSX.HTMLAttributes<HTMLElement>): T[\"element\"]\n  style: JSX.CSSProperties\n}\nexport function createNormalizer<T extends PropTypes>(fn: (props: Dict) => Dict): NormalizeProps<T> {\n  return new Proxy({} as any, {\n    get() {\n      return fn\n    },\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACyDO,SAAS,iBAAsC,IAA8C;AAClG,SAAO,IAAI,MAAM,CAAC,GAAU;AAAA,IAC1B,MAAM;AACJ,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/prop-types.ts"],"sourcesContent":["import type { JSX } from \"./jsx\"\n\nexport type RequiredBy<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>\n\nexport type Direction = \"ltr\" | \"rtl\"\n\nexport type Orientation = \"horizontal\" | \"vertical\"\n\nexport type MaybeElement<T extends HTMLElement = HTMLElement> = T | null\n\nexport interface OrientationProperty {\n  /**\n   * The orientation of the element.\n   * @default \"horizontal\"\n   */\n  orientation?: Orientation\n}\n\nexport interface DirectionProperty {\n  /**\n   * The document's text/writing direction.\n   * @default \"ltr\"\n   */\n  dir?: \"ltr\" | \"rtl\"\n}\n\nexport interface LocaleProperties extends DirectionProperty {\n  /**\n   * The current locale. Based on the BCP 47 definition.\n   * @default \"en-US\"\n   */\n  locale?: string\n}\n\nexport interface CommonProperties {\n  /**\n   * The unique identifier of the machine.\n   */\n  id: string\n  /**\n   * A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.\n   */\n  getRootNode?: () => ShadowRoot | Document | Node\n}\n\nexport interface RootProperties {\n  /**\n   * The owner document of the machine.\n   */\n  doc?: Document\n  /**\n   * The root node of the machine. Useful for shadow DOM.\n   */\n  rootNode?: ShadowRoot\n  /**\n   * The related target when the element is blurred.\n   * Used as a polyfill for `e.relatedTarget`\n   */\n  pointerdownNode?: HTMLElement | null\n}\n\nexport type Context<T> = T & RootProperties\n\nexport type Style = JSX.CSSProperties\n\nexport * from \"./prop-types\"\nexport type { JSX }\n","import type { JSX } from \"./jsx\"\n\ntype Dict<T = any> = Record<string, T>\n\ntype Booleanish = boolean | \"true\" | \"false\"\n\ntype DataAttr = {\n  \"data-selected\"?: Booleanish\n  \"data-expanded\"?: Booleanish\n  \"data-highlighted\"?: Booleanish\n  \"data-readonly\"?: Booleanish\n  \"data-indeterminate\"?: Booleanish\n  \"data-invalid\"?: Booleanish\n  \"data-hover\"?: Booleanish\n  \"data-active\"?: Booleanish\n  \"data-focus\"?: Booleanish\n  \"data-disabled\"?: Booleanish\n  \"data-open\"?: Booleanish\n  \"data-checked\"?: Booleanish\n  \"data-pressed\"?: Booleanish\n  \"data-complete\"?: Booleanish\n  \"data-empty\"?: Booleanish\n  \"data-placeholder-shown\"?: Booleanish\n  \"data-half\"?: Booleanish\n  \"data-scope\"?: string\n\n  \"data-uid\"?: string\n  \"data-name\"?: string\n  \"data-ownedby\"?: string\n  \"data-type\"?: string\n  \"data-valuetext\"?: string\n  \"data-placement\"?: string\n  \"data-controls\"?: string\n  \"data-part\"?: string\n  \"data-label\"?: string\n  \"data-state\"?: string | null\n  \"data-value\"?: string | number\n\n  \"data-orientation\"?: \"horizontal\" | \"vertical\"\n\n  \"data-count\"?: number\n  \"data-index\"?: number\n} & {\n  [key in `data-${string}`]?: string | number | Booleanish\n}\n\nexport type PropTypes<T = Dict> = Record<\n  \"button\" | \"label\" | \"input\" | \"img\" | \"output\" | \"element\" | \"select\" | \"style\",\n  T\n>\n\nexport type NormalizeProps<T extends PropTypes> = {\n  [K in keyof T]: (props: K extends keyof JSX.IntrinsicElements ? DataAttr & JSX.IntrinsicElements[K] : never) => T[K]\n} & {\n  element(props: DataAttr & JSX.HTMLAttributes<HTMLElement>): T[\"element\"]\n  style: JSX.CSSProperties\n}\nexport function createNormalizer<T extends PropTypes>(fn: (props: Dict) => Dict): NormalizeProps<T> {\n  return new Proxy({} as any, {\n    get() {\n      return fn\n    },\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACyDO,SAAS,iBAAsC,IAA8C;AAClG,SAAO,IAAI,MAAM,CAAC,GAAU;AAAA,IAC1B,MAAM;AACJ,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/types",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "keywords": [
     "js",
     "utils",

package/src/index.ts

@@ -24,6 +24,14 @@ export interface DirectionProperty {
   dir?: "ltr" | "rtl"
 }
 
+export interface LocaleProperties extends DirectionProperty {
+  /**
+   * The current locale. Based on the BCP 47 definition.
+   * @default "en-US"
+   */
+  locale?: string
+}
+
 export interface CommonProperties {
   /**
    * The unique identifier of the machine.