@codecademy/gamut-styles 17.13.2-alpha.f27e78.0 → 17.13.2-alpha.f38273.0

package/dist/utilities/elementDir.d.ts

@@ -1,15 +1,23 @@
 import type { RefObject } from 'react';
-/** Resolved HTML `dir` keyword: effective writing direction after `dir`, then CSS `direction`, then document root. */
+/**
+ * Resolved HTML `dir` keyword: effective writing direction after `dir`, then CSS
+ * `direction`, then document root.
+ */
 export type DirValue = 'rtl' | 'ltr';
 /**
  * Resolves the effective `dir` for an element (`rtl` or `ltr`), including JSDOM where
  * `getComputedStyle(el).direction` is often empty while `dir` is set on the root.
+ *
+ * @param el - DOM node whose effective direction is resolved.
+ * @returns `rtl` or `ltr`.
  */
 export declare function elementDir(el: Element): DirValue;
 /**
  * Ref whose `current` may be any DOM {@link Element} subclass (`HTMLElement`, `SVGElement`,
  * `HTMLButtonElement`, etc.). For structural/minimal types (e.g. tests), intersect with
  * `Element` so `current` is still typed as an `Element` (e.g. `Pick<HTMLAnchorElement, 'id'> & Element`).
+ *
+ * @template T - DOM element type for `current`; defaults to {@link Element}.
  */
 export type ElementDirRef<T extends Element = Element> = RefObject<T | null>;
 /**
@@ -17,6 +25,8 @@ export type ElementDirRef<T extends Element = Element> = RefObject<T | null>;
  * changes on the document subtree or after layout (so `ref.current` is current).
  * Resolution uses {@link elementDir}.
  *
+ * @template T - DOM element type for the optional ref; defaults to {@link Element}.
  * @param elementRef - Optional ref; when missing or `current` is not an `Element`, uses `document.documentElement`.
+ * @returns Effective direction for the resolved element, or `ltr` when `document` is undefined (SSR).
  */
 export declare function useElementDir<T extends Element = Element>(elementRef?: ElementDirRef<T>): DirValue;

package/dist/utilities/elementDir.js

@@ -1,10 +1,16 @@
 import { useEffect, useLayoutEffect, useReducer } from 'react';
 
-/** Resolved HTML `dir` keyword: effective writing direction after `dir`, then CSS `direction`, then document root. */
+/**
+ * Resolved HTML `dir` keyword: effective writing direction after `dir`, then CSS
+ * `direction`, then document root.
+ */
 
 /**
  * Resolves the effective `dir` for an element (`rtl` or `ltr`), including JSDOM where
  * `getComputedStyle(el).direction` is often empty while `dir` is set on the root.
+ *
+ * @param el - DOM node whose effective direction is resolved.
+ * @returns `rtl` or `ltr`.
  */
 export function elementDir(el) {
   const ownDir = el.getAttribute('dir');
@@ -23,6 +29,8 @@ export function elementDir(el) {
  * Ref whose `current` may be any DOM {@link Element} subclass (`HTMLElement`, `SVGElement`,
  * `HTMLButtonElement`, etc.). For structural/minimal types (e.g. tests), intersect with
  * `Element` so `current` is still typed as an `Element` (e.g. `Pick<HTMLAnchorElement, 'id'> & Element`).
+ *
+ * @template T - DOM element type for `current`; defaults to {@link Element}.
  */
 
 function resolveElement(elementRef) {
@@ -34,7 +42,9 @@ function resolveElement(elementRef) {
  * changes on the document subtree or after layout (so `ref.current` is current).
  * Resolution uses {@link elementDir}.
  *
+ * @template T - DOM element type for the optional ref; defaults to {@link Element}.
  * @param elementRef - Optional ref; when missing or `current` is not an `Element`, uses `document.documentElement`.
+ * @returns Effective direction for the resolved element, or `ltr` when `document` is undefined (SSR).
  */
 export function useElementDir(elementRef) {
   const [, bump] = useReducer(n => n + 1, 0);

package/dist/utilities/useLogicalProperties.d.ts

@@ -1,5 +1,5 @@
 /**
- * Whether Gamut system props emit logical CSS properties (`marginInlineStart`, etc.)
+ * Whether Gamut system props map to logical CSS properties (`marginInlineStart`, etc.)
  * vs physical (`marginLeft`, etc.).
  *
  * `GamutProvider` always merges an explicit boolean (default `false`).

package/dist/utilities/useLogicalProperties.js

@@ -1,7 +1,7 @@
 import { useTheme } from '@emotion/react';
 
 /**
- * Whether Gamut system props emit logical CSS properties (`marginInlineStart`, etc.)
+ * Whether Gamut system props map to logical CSS properties (`marginInlineStart`, etc.)
  * vs physical (`marginLeft`, etc.).
  *
  * `GamutProvider` always merges an explicit boolean (default `false`).

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@codecademy/gamut-styles",
   "description": "Styleguide & Component library for codecademy.com",
-  "version": "17.13.2-alpha.f27e78.0",
+  "version": "17.13.2-alpha.f38273.0",
   "author": "Jake Hiller <jake@codecademy.com>",
   "dependencies": {
-    "@codecademy/variance": "0.26.2-alpha.f27e78.0",
+    "@codecademy/variance": "0.26.2-alpha.f38273.0",
     "@emotion/is-prop-valid": "^1.1.0",
     "framer-motion": "^11.18.0",
     "get-nonce": "^1.0.0",