@react-foundry/component-helpers 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2019-2025 Crown Copyright
+Copyright (C) 2019-2026 Daniel A.C. Martin
+
+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.

package/README.md

@@ -0,0 +1,48 @@
+React Foundry - Component Helpers
+=================================
+
+Helper functions for writing components.
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @react-foundry/component-helpers
+```
+
+Then use it in your code as follows:
+
+```js
+import componentHelpers from '@react-foundry/component-helpers';
+
+// WRITEME
+
+```
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+```shell
+npm run clean
+```

package/dist/classes.d.ts

@@ -0,0 +1,15 @@
+type Modifiers = string | (string | undefined)[];
+export type StandardProps = {
+    /** 'id' attribute to place on the base HTML element */
+    id?: string;
+    /** Block name override in BEM style classes applied to all elements */
+    classBlock?: string;
+    /** BEM style modifiers to apply to the base HTML element */
+    classModifiers?: Modifiers;
+    /** Extra classes to apply to the base HTML element */
+    className?: string;
+};
+export type ClassBuilder = (element?: string, elementModifiers?: Modifiers, extra2?: string) => string | undefined;
+export declare const id: <T>(v: T) => T;
+export declare const classBuilder: (blockDefault: string, blockOverride?: string, blockModifiers?: Modifiers, extra?: string) => ClassBuilder;
+export {};

package/dist/classes.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classBuilder = exports.id = void 0;
+// Define a pointless component to coax react-docgen-typescript-loader
+const StandardComponent = (props) => null;
+const id = (v) => v;
+exports.id = id;
+const concatClasses = (...classes) => (
+// @ts-ignore
+classes
+    .flat(Infinity)
+    .filter(exports.id)
+    .join(' ') || undefined);
+const toArray = (v) => (Array.isArray(v)
+    ? v
+    : v && [v]);
+const classBuilder = (blockDefault, blockOverride, blockModifiers, extra) => {
+    const block = blockOverride || blockDefault;
+    const bModifiers = toArray(blockModifiers);
+    return (element, elementModifiers, extra2) => {
+        const eModifiers = toArray(elementModifiers);
+        return (element
+            ? concatClasses(`${block}__${element}`, eModifiers?.filter(exports.id).map(modifier => `${block}__${element}--${modifier}`), extra2)
+            : concatClasses(`${block}`, bModifiers?.filter(exports.id).map(modifier => `${block}--${modifier}`), extra));
+    };
+};
+exports.classBuilder = classBuilder;

package/dist/classes.mjs

@@ -0,0 +1,22 @@
+// Define a pointless component to coax react-docgen-typescript-loader
+const StandardComponent = (props) => null;
+export const id = (v) => v;
+const concatClasses = (...classes) => (
+// @ts-ignore
+classes
+    .flat(Infinity)
+    .filter(id)
+    .join(' ') || undefined);
+const toArray = (v) => (Array.isArray(v)
+    ? v
+    : v && [v]);
+export const classBuilder = (blockDefault, blockOverride, blockModifiers, extra) => {
+    const block = blockOverride || blockDefault;
+    const bModifiers = toArray(blockModifiers);
+    return (element, elementModifiers, extra2) => {
+        const eModifiers = toArray(elementModifiers);
+        return (element
+            ? concatClasses(`${block}__${element}`, eModifiers?.filter(id).map(modifier => `${block}__${element}--${modifier}`), extra2)
+            : concatClasses(`${block}`, bModifiers?.filter(id).map(modifier => `${block}--${modifier}`), extra));
+    };
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './classes';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./classes"), exports);

package/dist/index.mjs

@@ -0,0 +1 @@
+export * from './classes';

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@react-foundry/component-helpers",
+  "version": "0.1.0",
+  "description": "Helper functions for writing components.",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "5.9.3"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -m es2022 && find dist -name '*.js' -exec sh -c 'mv \"$0\" \"${0%.js}.mjs\"' {} \\;",
+    "build:cjs": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts"
+}