@uob-web-and-digital/component-library 2.7.2 → 2.7.4

package/dist/themeProps.d.ts

@@ -0,0 +1 @@
+export type ThemeProps = 'uobmain' | 'redexample';

package/dist/utils/ariaCarousel.d.ts

@@ -0,0 +1,29 @@
+import { UseEmblaCarouselType } from 'embla-carousel-react';
+import type { AriaAttributes } from 'react';
+import { FocusManagerOptions } from '../utils/getFocusableTreeWalker';
+type AriaCarouselAttributes = AriaAttributes & {
+    tabindex?: string;
+};
+type EmblaCarouselApi = UseEmblaCarouselType[1];
+/**
+ * Restores the mount value of an attribute on a node.
+ *
+ * @param node - The node which carries the attribute.
+ * @param attr - The attribute to restore.
+ */
+export declare function safelyRestoreNodeAttr(node: Node, attr: keyof AriaCarouselAttributes): void;
+/**
+ * Destroys the focus ability of an element. Moves the focus if necessary.
+ *
+ * @param node - The element to destory focus for.
+ * @param emblaApi - The Embla Carousel API instance.
+ */
+export declare function safelyDestroyFocus(node: HTMLElement, emblaApi?: EmblaCarouselApi): void;
+/**
+ * Executes a callback function for every focusable descendant.
+ *
+ * @param node - The node to start tree-walking from.
+ * @param callback - The callback function to invoke for every focusable node.
+ */
+export declare function executeForFocusDescendants(node: HTMLElement, callback: (...args: (Node | HTMLElement)[]) => void, options?: FocusManagerOptions): void;
+export {};

package/dist/utils/getFocusableTreeWalker.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Adapted from https://github.com/adobe/react-spectrum.
+ * Licensed under the Apache License.
+ */
+export declare function isElementInScope(element?: Element | null, scope?: Element[] | null): boolean;
+/**
+ * Adapted from https://github.com/adobe/react-spectrum.
+ * Licensed under the Apache License.
+ */
+export declare function isElementVisible(element: Element, childElement?: Element): boolean;
+export interface FocusManagerOptions {
+    /** The element to start searching from. The currently focused element by default. */
+    from?: Element;
+    /** Whether to only include tabbable elements, or all focusable elements. */
+    tabbable?: boolean;
+    /** Whether focus should wrap around when it reaches the end of the scope. */
+    wrap?: boolean;
+    /** A callback that determines whether the given element is focused. */
+    accept?: (node: Element) => boolean;
+}
+export declare const FOCUSABLE_ELEMENT_SELECTOR: string;
+export declare const TABBABLE_ELEMENT_SELECTOR: string;
+/**
+ * Create a [TreeWalker]{@link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker}
+ * that matches all focusable/tabbable elements.
+ *
+ * Adapted from https://github.com/adobe/react-spectrum.
+ * Licensed under the Apache License.
+ *
+ * @param root - Element to retrieve the TreeWalker for.
+ */
+export declare function getFocusableTreeWalker(root: Element, opts?: FocusManagerOptions, scope?: Element[]): TreeWalker;

package/dist/utils/util.d.ts

@@ -0,0 +1,3 @@
+import { ReactElement } from 'react';
+export declare function formatText(text: string, customClass?: string | undefined): ReactElement;
+export declare function formatKebabCase(string: string): string;

package/package.json

@@ -1,121 +1,121 @@
-{
-  "name": "@uob-web-and-digital/component-library",
-  "version": "2.7.2",
-  "description": "A component library using React and Storybook.",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/uob-itservices/component-library.git"
-  },
-  "bugs": {
-    "url": "https://github.com/uob-itservices/component-library/issues"
-  },
-  "homepage": "https://github.com/uob-itservices/component-library#readme",
-  "author": {
-    "name": "University of Birmingham"
-  },
-  "source": "src/index.ts",
-  "main": "dist/main.js",
-  "module": "dist/module.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "license": "",
-  "devDependencies": {
-    "@babel/preset-env": "^7.27.1",
-    "@babel/preset-react": "^7.27.1",
-    "@babel/preset-typescript": "^7.27.1",
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-image": "^3.0.3",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@storybook/addon-a11y": "^8.6.14",
-    "@storybook/addon-essentials": "^8.6.14",
-    "@storybook/addon-interactions": "^8.6.14",
-    "@storybook/addon-links": "^8.6.14",
-    "@storybook/addon-onboarding": "^8.6.14",
-    "@storybook/addon-styling-webpack": "^1.0.0",
-    "@storybook/addon-webpack5-compiler-swc": "^3.0.0",
-    "@storybook/blocks": "^8.6.14",
-    "@storybook/react": "^8.6.14",
-    "@storybook/react-webpack5": "^8.6.14",
-    "@types/pluralize": "^0.0.33",
-    "@types/react": "^18.3.23",
-    "@types/sanitize-html": "^2.16.0",
-    "autoprefixer": "^10.4.21",
-    "chromatic": "^11.29.0",
-    "eslint": "^8.57.1",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-plugin-prettier": "^5.5.4",
-    "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-storybook": "^0.6.15",
-    "file-loader": "^6.2.0",
-    "husky": "^8.0.0",
-    "lint-staged": "^14.0.1",
-    "postcss": "^8.5.6",
-    "postcss-loader": "^7.3.4",
-    "react-dom": "^18.3.1",
-    "resolve-url-loader": "^5.0.0",
-    "rollup": "^4.1.4",
-    "rollup-plugin-dts": "^6.1.0",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-postcss": "^4.0.2",
-    "rollup-plugin-scss": "^4.0.0",
-    "rollup-plugin-typescript2": "^0.36.0",
-    "sass": "^1.68.0",
-    "sass-loader": "^13.3.2",
-    "storybook": "^8.6.14",
-    "storybook-addon-performance": "^0.17.1",
-    "style-loader": "^3.3.3",
-    "stylelint": "^15.11.0",
-    "stylelint-config-idiomatic-order": "^9.0.0",
-    "stylelint-config-prettier-scss": "^1.0.0",
-    "stylelint-config-recommended": "^13.0.0",
-    "stylelint-config-recommended-scss": "^13.0.0",
-    "stylelint-config-sass-guidelines": "^10.0.0",
-    "stylelint-config-standard": "^34.0.0",
-    "stylelint-config-standard-scss": "^11.0.0",
-    "typescript": "^5.2.2"
-  },
-  "dependencies": {
-    "@storybook/addon-docs": "^8.6.14",
-    "@storybook/testing-library": "^0.2.2",
-    "clsx": "^2.1.1",
-    "embla-carousel-class-names": "^8.6.0",
-    "embla-carousel-react": "^8.6.0",
-    "focus-trap-react": "^10.3.1",
-    "framer-motion": "^12.23.12",
-    "pluralize": "^8.0.0",
-    "react": "^18.3.1"
-  },
-  "overrides": {
-    "stylelint-config-idiomatic-order": {
-      "stylelint": "^15.11.0"
-    }
-  },
-  "scripts": {
-    "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build",
-    "lint": "eslint \"./src/**/*.{js,jsx,ts,tsx}\" --max-warnings 0",
-    "lint-css": "stylelint --allow-empty-input '**/*.{css,scss}'",
-    "css-fix": "stylelint --fix '**/*.{css,scss}'",
-    "pretty": "prettier --write './**/*.{ts,tsx,scss,css,json,md,mdx}'",
-    "prepare": "husky install",
-    "pre-commit": "lint-staged",
-    "build-package": "rollup -c --bundleConfigAsCjs",
-    "chromatic": "npx chromatic --project-token=772c1293b28c"
-  },
-  "lint-staged": {
-    "src/**/*.{js,jsx,ts,tsx}": [
-      "npm run pretty",
-      "npm run lint"
-    ],
-    "src/**/*.{css,scss}": [
-      "npm run pretty",
-      "npm run lint-css"
-    ]
-  }
-}
+{
+  "name": "@uob-web-and-digital/component-library",
+  "version": "2.7.4",
+  "description": "A component library using React and Storybook.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uob-itservices/component-library.git"
+  },
+  "bugs": {
+    "url": "https://github.com/uob-itservices/component-library/issues"
+  },
+  "homepage": "https://github.com/uob-itservices/component-library#readme",
+  "author": {
+    "name": "University of Birmingham"
+  },
+  "source": "src/index.ts",
+  "main": "dist/main.js",
+  "module": "dist/module.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "",
+  "devDependencies": {
+    "@babel/preset-env": "^7.27.1",
+    "@babel/preset-react": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-image": "^3.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@storybook/addon-a11y": "^8.6.14",
+    "@storybook/addon-essentials": "^8.6.14",
+    "@storybook/addon-interactions": "^8.6.14",
+    "@storybook/addon-links": "^8.6.14",
+    "@storybook/addon-onboarding": "^8.6.14",
+    "@storybook/addon-styling-webpack": "^1.0.0",
+    "@storybook/addon-webpack5-compiler-swc": "^3.0.0",
+    "@storybook/blocks": "^8.6.14",
+    "@storybook/react": "^8.6.14",
+    "@storybook/react-webpack5": "^8.6.14",
+    "@types/pluralize": "^0.0.33",
+    "@types/react": "^18.3.23",
+    "@types/sanitize-html": "^2.16.0",
+    "autoprefixer": "^10.4.21",
+    "chromatic": "^11.29.0",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-storybook": "^0.6.15",
+    "file-loader": "^6.2.0",
+    "husky": "^8.0.0",
+    "lint-staged": "^14.0.1",
+    "postcss": "^8.5.6",
+    "postcss-loader": "^7.3.4",
+    "react-dom": "^18.3.1",
+    "resolve-url-loader": "^5.0.0",
+    "rollup": "^4.1.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-scss": "^4.0.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "sass": "^1.68.0",
+    "sass-loader": "^13.3.2",
+    "storybook": "^8.6.14",
+    "storybook-addon-performance": "^0.17.1",
+    "style-loader": "^3.3.3",
+    "stylelint": "^15.11.0",
+    "stylelint-config-idiomatic-order": "^9.0.0",
+    "stylelint-config-prettier-scss": "^1.0.0",
+    "stylelint-config-recommended": "^13.0.0",
+    "stylelint-config-recommended-scss": "^13.0.0",
+    "stylelint-config-sass-guidelines": "^10.0.0",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-config-standard-scss": "^11.0.0",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@storybook/addon-docs": "^8.6.14",
+    "@storybook/testing-library": "^0.2.2",
+    "clsx": "^2.1.1",
+    "embla-carousel-class-names": "^8.6.0",
+    "embla-carousel-react": "^8.6.0",
+    "focus-trap-react": "^10.3.1",
+    "framer-motion": "^12.23.12",
+    "pluralize": "^8.0.0",
+    "react": "^18.3.1"
+  },
+  "overrides": {
+    "stylelint-config-idiomatic-order": {
+      "stylelint": "^15.11.0"
+    }
+  },
+  "scripts": {
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build",
+    "lint": "eslint \"./src/**/*.{js,jsx,ts,tsx}\" --max-warnings 0",
+    "lint-css": "stylelint --allow-empty-input '**/*.{css,scss}'",
+    "css-fix": "stylelint --fix '**/*.{css,scss}'",
+    "pretty": "prettier --write './**/*.{ts,tsx,scss,css,json,md,mdx}'",
+    "prepare": "husky install",
+    "pre-commit": "lint-staged",
+    "build-package": "rollup -c --bundleConfigAsCjs",
+    "chromatic": "npx chromatic --project-token=772c1293b28c"
+  },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx}": [
+      "npm run pretty",
+      "npm run lint"
+    ],
+    "src/**/*.{css,scss}": [
+      "npm run pretty",
+      "npm run lint-css"
+    ]
+  }
+}