@nodeblocks/frontend-breadcrumb-block 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Breadcrumb.d.ts +9 -7
- package/dist/Breadcrumb.d.ts.map +1 -1
- package/dist/blocks.d.ts +1 -1
- package/dist/blocks.d.ts.map +1 -1
- package/dist/index.cjs.js +38 -21
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +38 -21
- package/dist/index.esm.js.map +1 -1
- package/dist/lib.d.ts +6 -3
- package/dist/lib.d.ts.map +1 -1
- package/package.json +11 -7
- package/readme.md +9 -2
package/dist/Breadcrumb.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
import { ComponentProps, ReactNode } from
|
|
2
|
-
import
|
|
3
|
-
import
|
|
1
|
+
import { ComponentProps, ReactNode } from 'react';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
import './breadcrumb.css';
|
|
4
|
+
import { BlocksOverride } from './lib';
|
|
5
|
+
import { BreadcrumbsProps } from '@mui/material';
|
|
4
6
|
declare const Breadcrumb: {
|
|
5
|
-
<CustomBlocks extends Record<string, ReactNode>>({
|
|
7
|
+
<CustomBlocks extends Record<string, ReactNode>>({ children, maxItems, itemsBeforeCollapse, itemsAfterCollapse, ...breadcrumbsProps }: {
|
|
6
8
|
children?: BlocksOverride<typeof defaultBlocks, CustomBlocks>;
|
|
7
|
-
}): import("react/jsx-runtime").JSX.Element;
|
|
9
|
+
} & Omit<BreadcrumbsProps, "children">): import("react/jsx-runtime").JSX.Element;
|
|
8
10
|
BreadcrumbChevron: () => import("react/jsx-runtime").JSX.Element;
|
|
9
11
|
BreadcrumbItem: ({ url, children, }: Omit<ComponentProps<"a">, "children"> & {
|
|
10
12
|
url: string;
|
|
@@ -12,8 +14,8 @@ declare const Breadcrumb: {
|
|
|
12
14
|
}) => import("react/jsx-runtime").JSX.Element;
|
|
13
15
|
};
|
|
14
16
|
declare const defaultBlocks: {
|
|
15
|
-
breadcrumbChevron:
|
|
16
|
-
breadcrumbItem:
|
|
17
|
+
breadcrumbChevron: React.ReactElement<unknown, () => import("react/jsx-runtime").JSX.Element>;
|
|
18
|
+
breadcrumbItem: React.ReactElement<Omit<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "children"> & {
|
|
17
19
|
url: string;
|
|
18
20
|
children: ReactNode;
|
|
19
21
|
}, ({ url, children, }: Omit<ComponentProps<"a">, "children"> & {
|
package/dist/Breadcrumb.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Breadcrumb.d.ts","sourceRoot":"","sources":["../src/Breadcrumb.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"Breadcrumb.d.ts","sourceRoot":"","sources":["../src/Breadcrumb.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAgD,MAAM,OAAO,CAAC;AACrF,OAAO,EAAe,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE9D,QAAA,MAAM,UAAU;KAAI,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,wFAM/D;QACD,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,aAAa,EAAE,YAAY,CAAC,CAAC;KAC/D,GAAG,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC;;;;;;CA8BrC,CAAC;AAKF,QAAA,MAAM,aAAa;;;;;;;;;CAGjB,CAAC;AAEH,eAAe,UAAU,CAAC"}
|
package/dist/blocks.d.ts
CHANGED
package/dist/blocks.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlD,eAAO,MAAM,cAAc,GAAI,oBAG5B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,SAAS,CAAC;CACrB,4CAcA,CAAC;AAEF,eAAO,MAAM,iBAAiB,+CAW7B,CAAC"}
|
package/dist/index.cjs.js
CHANGED
|
@@ -1,10 +1,27 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
if (typeof global === 'undefined') {
|
|
4
|
+
var global = window;
|
|
5
|
+
}
|
|
6
|
+
|
|
1
7
|
'use strict';
|
|
2
8
|
|
|
3
9
|
var jsxRuntime = require('react/jsx-runtime');
|
|
4
|
-
var
|
|
10
|
+
var React = require('react');
|
|
11
|
+
var material = require('@mui/material');
|
|
5
12
|
|
|
6
|
-
const BreadcrumbItem = ({ url, children, }) =>
|
|
7
|
-
const
|
|
13
|
+
const BreadcrumbItem = ({ url, children, }) => {
|
|
14
|
+
const theme = material.useTheme();
|
|
15
|
+
return (
|
|
16
|
+
// TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme
|
|
17
|
+
jsxRuntime.jsx(material.Link, { underline: "hover", color: "inherit", href: url, fontSize: theme.typography.caption.fontSize, fontWeight: theme.typography.caption.fontWeight, children: children }));
|
|
18
|
+
};
|
|
19
|
+
const BreadcrumbChevron = () => {
|
|
20
|
+
const theme = material.useTheme();
|
|
21
|
+
return (
|
|
22
|
+
// TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme
|
|
23
|
+
jsxRuntime.jsx(material.SvgIcon, { sx: { fontSize: theme.typography.caption.fontSize, color: theme.palette.primary.contrastText }, viewBox: "0 0 8 12", children: jsxRuntime.jsx("path", { d: "M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z" }) }));
|
|
24
|
+
};
|
|
8
25
|
|
|
9
26
|
function styleInject(css, ref) {
|
|
10
27
|
if ( ref === void 0 ) ref = {};
|
|
@@ -33,7 +50,7 @@ function styleInject(css, ref) {
|
|
|
33
50
|
}
|
|
34
51
|
}
|
|
35
52
|
|
|
36
|
-
var css_248z = ".nbb-breadcrumb {\n
|
|
53
|
+
var css_248z = ".nbb-breadcrumb.MuiBreadcrumbs-root {\n padding: calc(var(--mui-spacing) * 1.5) calc(var(--mui-spacing) * 2);\n background-color: var(--mui-palette-primary-main);\n color: var(--mui-palette-primary-contrastText);\n border-bottom: 1px solid rgba(255, 255, 255, 0.2);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-ol {\n gap: var(--mui-spacing);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-li {\n display: flex;\n align-items: center;\n gap: var(--mui-spacing);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-separator {\n display: none;\n}\n";
|
|
37
54
|
styleInject(css_248z);
|
|
38
55
|
|
|
39
56
|
/**
|
|
@@ -49,10 +66,7 @@ styleInject(css_248z);
|
|
|
49
66
|
* });
|
|
50
67
|
*/
|
|
51
68
|
function createDefaultBlocks(components) {
|
|
52
|
-
return Object.fromEntries(Object.entries(components).map(([key, Component]) => [
|
|
53
|
-
key,
|
|
54
|
-
react.createElement(Component, { key }),
|
|
55
|
-
]));
|
|
69
|
+
return Object.fromEntries(Object.entries(components).map(([key, Component]) => [key, React.createElement(Component, { key })]));
|
|
56
70
|
}
|
|
57
71
|
/**
|
|
58
72
|
* A component for rendering {@link BlocksOverride|`BlocksOverride`} results.
|
|
@@ -76,6 +90,7 @@ function createDefaultBlocks(components) {
|
|
|
76
90
|
* </BlocksOverrideComponent>
|
|
77
91
|
*/
|
|
78
92
|
function BlocksOverrideComponent({ blocksOverride, defaultBlocks, defaultBlockOrder, children, }) {
|
|
93
|
+
// 1. standard "default" block use with no customization
|
|
79
94
|
if (blocksOverride === undefined) {
|
|
80
95
|
return children({
|
|
81
96
|
// TODO: Remove this assertion
|
|
@@ -83,30 +98,32 @@ function BlocksOverrideComponent({ blocksOverride, defaultBlocks, defaultBlockOr
|
|
|
83
98
|
blockOrder: defaultBlockOrder,
|
|
84
99
|
});
|
|
85
100
|
}
|
|
86
|
-
|
|
101
|
+
// 2.when user uses "child function" customization pattern, that returns the "override" object of blocks/blockOrder
|
|
102
|
+
if (typeof blocksOverride === 'function') {
|
|
87
103
|
const { blocks, blockOrder } = blocksOverride({
|
|
88
104
|
defaultBlocks,
|
|
89
105
|
defaultBlockOrder,
|
|
90
106
|
});
|
|
91
107
|
return children({ blocks, blockOrder });
|
|
92
108
|
}
|
|
109
|
+
// 3. when user uses "compound components" customization pattern, passing in their own chosen elements
|
|
93
110
|
return blocksOverride;
|
|
94
111
|
}
|
|
95
|
-
/**
|
|
96
|
-
* Utility function to join class names together, ignoring undefined or nil values.
|
|
97
|
-
* @param classes - The class names to join.
|
|
98
|
-
* @returns The joined class names.
|
|
99
|
-
*/
|
|
100
|
-
function classNames(...classes) {
|
|
101
|
-
return classes.flat().filter(Boolean).join(" ");
|
|
102
|
-
}
|
|
103
112
|
|
|
104
|
-
const Breadcrumb = ({
|
|
105
|
-
return (jsxRuntime.jsx(
|
|
113
|
+
const Breadcrumb = ({ children, maxItems = 8, itemsBeforeCollapse = 1, itemsAfterCollapse = 1, ...breadcrumbsProps }) => {
|
|
114
|
+
return (jsxRuntime.jsx(material.Breadcrumbs, { ...breadcrumbsProps, className: "nbb-breadcrumb", "aria-label": "breadcrumb", maxItems: maxItems, itemsBeforeCollapse: itemsBeforeCollapse, itemsAfterCollapse: itemsAfterCollapse, children: BlocksOverrideComponent({
|
|
115
|
+
defaultBlocks: defaultBlocks,
|
|
116
|
+
defaultBlockOrder: Object.keys(defaultBlocks),
|
|
117
|
+
blocksOverride: children,
|
|
118
|
+
children: ({ blocks: { breadcrumbChevron, breadcrumbItem, ...blocks }, blockOrder }) => blockOrder
|
|
106
119
|
.filter((key) => key in blocks)
|
|
107
120
|
.map((key, index) => {
|
|
108
|
-
return (
|
|
109
|
-
|
|
121
|
+
return (
|
|
122
|
+
// NOTE: the contents of this "children" property is only used for/rendered in the override child function "override" pattern
|
|
123
|
+
// for this to work, the user should pass in breadcrumbItem (or equivalent), and shouldn't pass in the breadcrumbChevron element to the blocks override object (since we append it here)
|
|
124
|
+
jsxRuntime.jsxs(React.Fragment, { children: [index > 0 && breadcrumbChevron, blocks[key]] }, `${index}-breadcrumb`));
|
|
125
|
+
}),
|
|
126
|
+
}) }));
|
|
110
127
|
};
|
|
111
128
|
Breadcrumb.BreadcrumbChevron = BreadcrumbChevron;
|
|
112
129
|
Breadcrumb.BreadcrumbItem = BreadcrumbItem;
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/blocks.tsx","../node_modules/style-inject/dist/style-inject.es.js","../src/lib.ts","../src/Breadcrumb.tsx"],"sourcesContent":["import { ComponentProps, ReactNode } from \"react\";\n\nexport const BreadcrumbItem = ({\n url,\n children,\n}: Omit<ComponentProps<\"a\">, \"children\"> & {\n url: string;\n children: ReactNode;\n}) => (\n <a href={url} className=\"nbb-breadcrumb-item\">\n {children}\n </a>\n);\n\nexport const BreadcrumbChevron = () => (\n <span className=\"nbb-breadcrumb-chevron\">\n <svg\n width=\"8\"\n height=\"12\"\n viewBox=\"0 0 8 12\"\n fill=\"none\"\n xmlns=\"http://www.w3.org/2000/svg\"\n >\n <path\n d=\"M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z\"\n fill=\"white\"\n />\n </svg>\n </span>\n);\n","function styleInject(css, ref) {\n if ( ref === void 0 ) ref = {};\n var insertAt = ref.insertAt;\n\n if (!css || typeof document === 'undefined') { return; }\n\n var head = document.head || document.getElementsByTagName('head')[0];\n var style = document.createElement('style');\n style.type = 'text/css';\n\n if (insertAt === 'top') {\n if (head.firstChild) {\n head.insertBefore(style, head.firstChild);\n } else {\n head.appendChild(style);\n }\n } else {\n head.appendChild(style);\n }\n\n if (style.styleSheet) {\n style.styleSheet.cssText = css;\n } else {\n style.appendChild(document.createTextNode(css));\n }\n}\n\nexport default styleInject;\n","import {\n ComponentProps,\n createElement,\n FunctionComponent,\n ReactElement,\n ReactNode,\n} from \"react\";\n\n/**\n * The function to be passed into a block component as `children` to selectively override default blocks, or just a `ReactNode`.\n *\n * @example\n * <Block>\n * {({header, ...defaultBlocks}) => ({\n * blocks: {\n * ...defaultBlocks,\n * header: {\n * ...header,\n * props: {\n * ...header.props,\n * label: \"Custom Label\"\n * }\n * },\n * subheader: <CustomComponent />\n * },\n * blockOrder: [\"header\", \"subheader\", \"body\", \"footer\"]\n * })}\n * </Block>\n */\nexport type BlocksOverride<DefaultBlocks, CustomBlocks> =\n | (({\n defaultBlocks,\n defaultBlockOrder,\n }: {\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: readonly (keyof DefaultBlocks)[];\n }) => {\n blocks: Partial<DefaultBlocks> & CustomBlocks;\n // NOTE: This specific combination allows proper autocomplete.\n blockOrder:\n | readonly (keyof DefaultBlocks)[]\n | readonly (keyof CustomBlocks)[];\n })\n | ReactNode;\n\n/**\n * Creates a strongly typed `defaultBlocks` object, allowing for types to propagate into block override objects.\n *\n * @param components - A map of default block keys to component functions.\n *\n * @example\n * const defaultBlocks = createDefaultBlocks({\n * title: Title,\n * description: Description,\n * form: Form,\n * });\n */\nexport function createDefaultBlocks<\n T extends Record<string, FunctionComponent<any>>,\n>(\n components: T\n): {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n} {\n return Object.fromEntries(\n Object.entries(components).map(([key, Component]) => [\n key,\n createElement(Component, { key }),\n ])\n ) as {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n };\n}\n\n/**\n * A component for rendering {@link BlocksOverride|`BlocksOverride`} results.\n * Exposes the evaluated `blocks` and `blockOrder` as arguments to the `children` function.\n *\n * @param props\n * @param props.blocksOverride - The {@link BlocksOverride|`BlocksOverride`} (i.e. `children` of outer component).\n * @param props.defaultBlocks - The default blocks of outer component.\n * @param props.children - A function returning the JSX to render.\n *\n * @example\n * <BlocksOverrideComponent\n * defaultBlocks={defaultFormBlocks}\n * blocksOverride={children}\n * >\n * {({ blocks, blockOrder }) =>\n * blockOrder.map((key) => (\n * <Fragment key={String(key)}>{blocks[key]}</Fragment>\n * ))\n * }\n * </BlocksOverrideComponent>\n */\nexport function BlocksOverrideComponent<\n DefaultBlocks extends Record<string, ReactNode>,\n CustomBlocks extends Record<string, ReactNode>,\n>({\n blocksOverride,\n defaultBlocks,\n defaultBlockOrder,\n children,\n}: {\n blocksOverride: BlocksOverride<DefaultBlocks, CustomBlocks>;\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: (keyof DefaultBlocks)[];\n children: ({\n blocks,\n blockOrder,\n }: {\n // TODO: Possibly find an alternative to Partial<CustomBlocks>\n blocks: Partial<DefaultBlocks> & Partial<CustomBlocks>;\n blockOrder: readonly (keyof DefaultBlocks | keyof CustomBlocks)[];\n }) => ReactNode;\n}) {\n if (blocksOverride === undefined) {\n return children({\n // TODO: Remove this assertion\n blocks: defaultBlocks as DefaultBlocks & Partial<CustomBlocks>,\n blockOrder: defaultBlockOrder,\n });\n }\n\n if (typeof blocksOverride === \"function\") {\n const { blocks, blockOrder } = blocksOverride({\n defaultBlocks,\n defaultBlockOrder,\n });\n\n return children({ blocks, blockOrder });\n }\n\n return blocksOverride;\n}\n\nexport function deepMerge<\n A extends Record<string, any>,\n B extends Record<string, any>,\n>(obj1: A, obj2: B) {\n const result: Record<string, any> = { ...obj1 };\n\n for (const key in obj2) {\n if (obj2.hasOwnProperty(key)) {\n const val1 = result[key];\n const val2 = obj2[key];\n\n if (Array.isArray(val1) || Array.isArray(val2)) {\n // If either is an array, replace entirely with obj2's value\n result[key] = val2;\n } else if (\n typeof val1 === \"object\" &&\n val1 !== null &&\n typeof val2 === \"object\" &&\n val2 !== null\n ) {\n result[key] = deepMerge(val1, val2);\n } else {\n result[key] = val2;\n }\n }\n }\n\n return result as A & B;\n}\n\ntype ClassName = string | ClassName[] | undefined | null;\n\n/**\n * Utility function to join class names together, ignoring undefined or nil values.\n * @param classes - The class names to join.\n * @returns The joined class names.\n */\nexport function classNames(...classes: ClassName[]): string {\n return classes.flat().filter(Boolean).join(\" \");\n}\n","import { ComponentProps, ReactNode } from \"react\";\nimport { BreadcrumbChevron, BreadcrumbItem } from \"./blocks\";\nimport \"./breadcrumb.css\";\nimport {\n BlocksOverride,\n BlocksOverrideComponent,\n classNames,\n createDefaultBlocks,\n} from \"./lib\";\n\nconst Breadcrumb = <CustomBlocks extends Record<string, ReactNode>>({\n className,\n children,\n}: Omit<ComponentProps<\"nav\">, \"children\"> & {\n children?: BlocksOverride<typeof defaultBlocks, CustomBlocks>;\n}) => {\n return (\n <nav className={classNames(\"nbb-breadcrumb\", className)}>\n <BlocksOverrideComponent\n defaultBlocks={defaultBlocks}\n defaultBlockOrder={\n Object.keys(defaultBlocks) as (keyof typeof defaultBlocks)[]\n }\n blocksOverride={children}\n >\n {({\n blocks: { breadcrumbChevron, breadcrumbItem, ...blocks },\n blockOrder,\n }) =>\n blockOrder\n .filter((key) => key in blocks)\n .map<ReactNode>((key, index) => {\n return (\n <span\n key={`${index}-breadcrumb`}\n className=\"nbb-breadcrumb-segment\"\n >\n {index > 0 && breadcrumbChevron}\n {blocks[key]}\n </span>\n );\n })\n }\n </BlocksOverrideComponent>\n </nav>\n );\n};\n\nBreadcrumb.BreadcrumbChevron = BreadcrumbChevron;\nBreadcrumb.BreadcrumbItem = BreadcrumbItem;\n\nconst defaultBlocks = createDefaultBlocks({\n breadcrumbChevron: BreadcrumbChevron,\n breadcrumbItem: BreadcrumbItem,\n});\n\nexport default Breadcrumb;\n"],"names":["_jsx","createElement","_jsxs"],"mappings":";;;;;AAEO,MAAM,cAAc,GAAG,CAAC,EAC7B,GAAG,EACH,QAAQ,GAIT,MACCA,cAAG,CAAA,GAAA,EAAA,EAAA,IAAI,EAAE,GAAG,EAAE,SAAS,EAAC,qBAAqB,EAC1C,QAAA,EAAA,QAAQ,EACP,CAAA,CACL;AAEM,MAAM,iBAAiB,GAAG,OAC/BA,cAAM,CAAA,MAAA,EAAA,EAAA,SAAS,EAAC,wBAAwB,EAAA,QAAA,EACtCA,wBACE,KAAK,EAAC,GAAG,EACT,MAAM,EAAC,IAAI,EACX,OAAO,EAAC,UAAU,EAClB,IAAI,EAAC,MAAM,EACX,KAAK,EAAC,4BAA4B,EAElC,QAAA,EAAAA,cAAA,CAAA,MAAA,EAAA,EACE,CAAC,EAAC,wFAAwF,EAC1F,IAAI,EAAC,OAAO,EACZ,CAAA,EAAA,CACE,EACD,CAAA,CACR;;AC7BD,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE;AAC/B,EAAE,KAAK,GAAG,KAAK,MAAM,GAAG,GAAG,GAAG,EAAE;AAChC,EAAE,IAAI,QAAQ,GAAG,GAAG,CAAC,QAAQ;;AAE7B,EAAE,IAAY,OAAO,QAAQ,KAAK,WAAW,EAAE,EAAE,OAAO;;AAExD,EAAE,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACtE,EAAE,IAAI,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC;AAC7C,EAAE,KAAK,CAAC,IAAI,GAAG,UAAU;;AAEzB,EAAE,IAAI,QAAQ,KAAK,KAAK,EAAE;AAC1B,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE;AACzB,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;AAC/C,KAAK,MAAM;AACX,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC7B;AACA,GAAG,MAAM;AACT,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC3B;;AAEA,EAAE,IAAI,KAAK,CAAC,UAAU,EAAE;AACxB,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG;AAClC,GAAG,MAAM;AACT,IAAI,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AACnD;AACA;;;;;ACoBA;;;;;;;;;;;AAWG;AACG,SAAU,mBAAmB,CAGjC,UAAa,EAAA;IAIb,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK;QACnD,GAAG;AACH,QAAAC,mBAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC;AAClC,KAAA,CAAC,CAGH;AACH;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,uBAAuB,CAGrC,EACA,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,QAAQ,GAaT,EAAA;AACC,IAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,QAAA,OAAO,QAAQ,CAAC;;AAEd,YAAA,MAAM,EAAE,aAAsD;AAC9D,YAAA,UAAU,EAAE,iBAAiB;AAC9B,SAAA,CAAC;;AAGJ,IAAA,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;AACxC,QAAA,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;YAC5C,aAAa;YACb,iBAAiB;AAClB,SAAA,CAAC;QAEF,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;;AAGzC,IAAA,OAAO,cAAc;AACvB;AAkCA;;;;AAIG;AACa,SAAA,UAAU,CAAC,GAAG,OAAoB,EAAA;AAChD,IAAA,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AACjD;;ACrKM,MAAA,UAAU,GAAG,CAAiD,EAClE,SAAS,EACT,QAAQ,GAGT,KAAI;IACH,QACED,wBAAK,SAAS,EAAE,UAAU,CAAC,gBAAgB,EAAE,SAAS,CAAC,EAAA,QAAA,EACrDA,eAAC,uBAAuB,EAAA,EACtB,aAAa,EAAE,aAAa,EAC5B,iBAAiB,EACf,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmC,EAE9D,cAAc,EAAE,QAAQ,YAEvB,CAAC,EACA,MAAM,EAAE,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EACxD,UAAU,GACX,KACC;iBACG,MAAM,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,MAAM;AAC7B,iBAAA,GAAG,CAAY,CAAC,GAAG,EAAE,KAAK,KAAI;gBAC7B,QACEE,0BAEE,SAAS,EAAC,wBAAwB,EAEjC,QAAA,EAAA,CAAA,KAAK,GAAG,CAAC,IAAI,iBAAiB,EAC9B,MAAM,CAAC,GAAG,CAAC,CAAA,EAAA,EAJP,GAAG,KAAK,CAAA,WAAA,CAAa,CAKrB;AAEX,aAAC,CAAC,EAAA,CAEkB,EACtB,CAAA;AAEV;AAEA,UAAU,CAAC,iBAAiB,GAAG,iBAAiB;AAChD,UAAU,CAAC,cAAc,GAAG,cAAc;AAE1C,MAAM,aAAa,GAAG,mBAAmB,CAAC;AACxC,IAAA,iBAAiB,EAAE,iBAAiB;AACpC,IAAA,cAAc,EAAE,cAAc;AAC/B,CAAA,CAAC;;;;","x_google_ignoreList":[1]}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/blocks.tsx","../node_modules/style-inject/dist/style-inject.es.js","../src/lib.ts","../src/Breadcrumb.tsx"],"sourcesContent":["import { ComponentProps, ReactNode } from 'react';\nimport { Link, SvgIcon, useTheme } from '@mui/material';\n\nexport const BreadcrumbItem = ({\n url,\n children,\n}: Omit<ComponentProps<'a'>, 'children'> & {\n url: string;\n children: ReactNode;\n}) => {\n const theme = useTheme();\n return (\n // TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme\n <Link\n underline=\"hover\"\n color=\"inherit\"\n href={url}\n fontSize={theme.typography.caption.fontSize}\n fontWeight={theme.typography.caption.fontWeight}\n >\n {children}\n </Link>\n );\n};\n\nexport const BreadcrumbChevron = () => {\n const theme = useTheme();\n return (\n // TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme\n <SvgIcon\n sx={{ fontSize: theme.typography.caption.fontSize, color: theme.palette.primary.contrastText }}\n viewBox=\"0 0 8 12\"\n >\n <path d=\"M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z\" />\n </SvgIcon>\n );\n};\n","function styleInject(css, ref) {\n if ( ref === void 0 ) ref = {};\n var insertAt = ref.insertAt;\n\n if (!css || typeof document === 'undefined') { return; }\n\n var head = document.head || document.getElementsByTagName('head')[0];\n var style = document.createElement('style');\n style.type = 'text/css';\n\n if (insertAt === 'top') {\n if (head.firstChild) {\n head.insertBefore(style, head.firstChild);\n } else {\n head.appendChild(style);\n }\n } else {\n head.appendChild(style);\n }\n\n if (style.styleSheet) {\n style.styleSheet.cssText = css;\n } else {\n style.appendChild(document.createTextNode(css));\n }\n}\n\nexport default styleInject;\n","import { ComponentProps, createElement, FunctionComponent, ReactElement, ReactNode } from 'react';\n\n/**\n * The function to be passed into a block component as `children` to selectively override default blocks, or just a `ReactNode`.\n *\n * @example\n * <Block>\n * {({ defaultBlocks: { header, ...defaultBlocks }, defaultBlockOrder }) => ({\n * blocks: {\n * ...defaultBlocks,\n * header: {\n * ...header,\n * props: {\n * ...header.props,\n * label: \"Custom Label\"\n * }\n * },\n * subheader: <CustomComponent />\n * },\n * blockOrder: [\"header\", \"subheader\", \"body\", \"footer\"]\n * })}\n * </Block>\n */\nexport type BlocksOverride<DefaultBlocks, CustomBlocks> =\n | (({\n defaultBlocks,\n defaultBlockOrder,\n }: {\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: readonly (keyof DefaultBlocks)[];\n }) => {\n blocks: Partial<DefaultBlocks> & CustomBlocks;\n // NOTE: This specific combination allows proper autocomplete.\n blockOrder: readonly (keyof DefaultBlocks)[] | readonly (keyof CustomBlocks)[];\n })\n | ReactNode;\n\n/**\n * Creates a strongly typed `defaultBlocks` object, allowing for types to propagate into block override objects.\n *\n * @param components - A map of default block keys to component functions.\n *\n * @example\n * const defaultBlocks = createDefaultBlocks({\n * title: Title,\n * description: Description,\n * form: Form,\n * });\n */\nexport function createDefaultBlocks<T extends Record<string, FunctionComponent<any>>>(\n components: T\n): {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n} {\n return Object.fromEntries(\n Object.entries(components).map(([key, Component]) => [key, createElement(Component, { key })])\n ) as {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n };\n}\n\n/**\n * A component for rendering {@link BlocksOverride|`BlocksOverride`} results.\n * Exposes the evaluated `blocks` and `blockOrder` as arguments to the `children` function.\n *\n * @param props\n * @param props.blocksOverride - The {@link BlocksOverride|`BlocksOverride`} (i.e. `children` of outer component).\n * @param props.defaultBlocks - The default blocks of outer component.\n * @param props.children - A function returning the JSX to render.\n *\n * @example\n * <BlocksOverrideComponent\n * defaultBlocks={defaultFormBlocks}\n * blocksOverride={children}\n * >\n * {({ blocks, blockOrder }) =>\n * blockOrder.map((key) => (\n * <Fragment key={String(key)}>{blocks[key]}</Fragment>\n * ))\n * }\n * </BlocksOverrideComponent>\n */\nexport function BlocksOverrideComponent<\n DefaultBlocks extends Record<string, ReactNode>,\n CustomBlocks extends Record<string, ReactNode>,\n>({\n blocksOverride,\n defaultBlocks,\n defaultBlockOrder,\n children,\n}: {\n blocksOverride: BlocksOverride<DefaultBlocks, CustomBlocks>;\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: (keyof DefaultBlocks)[];\n children: ({\n blocks,\n blockOrder,\n }: {\n // TODO: Possibly find an alternative to Partial<CustomBlocks>\n blocks: Partial<DefaultBlocks> & Partial<CustomBlocks>;\n blockOrder: readonly (keyof DefaultBlocks | keyof CustomBlocks)[];\n }) => ReactNode;\n}) {\n // 1. standard \"default\" block use with no customization\n if (blocksOverride === undefined) {\n return children({\n // TODO: Remove this assertion\n blocks: defaultBlocks as DefaultBlocks & Partial<CustomBlocks>,\n blockOrder: defaultBlockOrder,\n });\n }\n\n // 2.when user uses \"child function\" customization pattern, that returns the \"override\" object of blocks/blockOrder\n if (typeof blocksOverride === 'function') {\n const { blocks, blockOrder } = blocksOverride({\n defaultBlocks,\n defaultBlockOrder,\n });\n\n return children({ blocks, blockOrder });\n }\n\n // 3. when user uses \"compound components\" customization pattern, passing in their own chosen elements\n return blocksOverride;\n}\n\ntype MergeTypes<Object1, Object2> = {\n [K in keyof Object1 | keyof Object2]: K extends keyof Object1\n ? Object1[K]\n : K extends keyof Object2\n ? Object2[K]\n : never;\n};\n\nexport function deepMerge<A extends Record<string, any>, B extends Record<string, any>>(obj1: A, obj2: B) {\n const result: Record<string, any> = { ...obj1 };\n\n for (const key in obj2) {\n if (obj2.hasOwnProperty(key)) {\n const val1 = result[key];\n const val2 = obj2[key];\n\n if (Array.isArray(val1) || Array.isArray(val2)) {\n // If either is an array, replace entirely with obj2's value\n result[key] = val2;\n } else if (typeof val1 === 'object' && val1 !== null && typeof val2 === 'object' && val2 !== null) {\n result[key] = deepMerge(val1, val2);\n } else {\n result[key] = val2;\n }\n }\n }\n\n return result as MergeTypes<B, A>;\n}\n\ntype ClassName = string | ClassName[] | undefined | null;\n\n/**\n * Utility function to join class names together, ignoring undefined or nil values.\n * @param classes - The class names to join.\n * @returns The joined class names.\n */\nexport function classNames(...classes: ClassName[]): string {\n return classes.flat().filter(Boolean).join(' ');\n}\n","import { ComponentProps, ReactNode } from 'react';\nimport React from 'react';\nimport { BreadcrumbChevron, BreadcrumbItem } from './blocks';\nimport './breadcrumb.css';\nimport { BlocksOverride, BlocksOverrideComponent, createDefaultBlocks } from './lib';\nimport { Breadcrumbs, BreadcrumbsProps } from '@mui/material';\n\nconst Breadcrumb = <CustomBlocks extends Record<string, ReactNode>>({\n children,\n maxItems = 8,\n itemsBeforeCollapse = 1,\n itemsAfterCollapse = 1,\n ...breadcrumbsProps\n}: {\n children?: BlocksOverride<typeof defaultBlocks, CustomBlocks>;\n} & Omit<BreadcrumbsProps, 'children'>) => {\n return (\n <Breadcrumbs\n {...breadcrumbsProps}\n className=\"nbb-breadcrumb\"\n aria-label=\"breadcrumb\"\n maxItems={maxItems}\n itemsBeforeCollapse={itemsBeforeCollapse}\n itemsAfterCollapse={itemsAfterCollapse}\n >\n {BlocksOverrideComponent({\n defaultBlocks: defaultBlocks,\n defaultBlockOrder: Object.keys(defaultBlocks) as (keyof typeof defaultBlocks)[],\n blocksOverride: children,\n children: ({ blocks: { breadcrumbChevron, breadcrumbItem, ...blocks }, blockOrder }) =>\n blockOrder\n .filter((key) => key in blocks)\n .map<ReactNode>((key, index) => {\n return (\n // NOTE: the contents of this \"children\" property is only used for/rendered in the override child function \"override\" pattern\n // for this to work, the user should pass in breadcrumbItem (or equivalent), and shouldn't pass in the breadcrumbChevron element to the blocks override object (since we append it here)\n <React.Fragment key={`${index}-breadcrumb`}>\n {index > 0 && breadcrumbChevron}\n {blocks[key]}\n </React.Fragment>\n );\n }),\n })}\n </Breadcrumbs>\n );\n};\n\nBreadcrumb.BreadcrumbChevron = BreadcrumbChevron;\nBreadcrumb.BreadcrumbItem = BreadcrumbItem;\n\nconst defaultBlocks = createDefaultBlocks({\n breadcrumbChevron: BreadcrumbChevron,\n breadcrumbItem: BreadcrumbItem,\n});\n\nexport default Breadcrumb;\n"],"names":["useTheme","_jsx","Link","SvgIcon","createElement","Breadcrumbs","_jsxs"],"mappings":";;;;;;;;;;;;AAGO,MAAM,cAAc,GAAG,CAAC,EAC7B,GAAG,EACH,QAAQ,GAIT,KAAI;AACH,IAAA,MAAM,KAAK,GAAGA,iBAAQ,EAAE;IACxB;;AAEE,IAAAC,cAAA,CAACC,aAAI,EAAA,EACH,SAAS,EAAC,OAAO,EACjB,KAAK,EAAC,SAAS,EACf,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAC3C,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,YAE9C,QAAQ,EAAA,CACJ;AAEX,CAAC;AAEM,MAAM,iBAAiB,GAAG,MAAK;AACpC,IAAA,MAAM,KAAK,GAAGF,iBAAQ,EAAE;IACxB;;AAEE,IAAAC,cAAA,CAACE,gBAAO,EAAA,EACN,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,EAC9F,OAAO,EAAC,UAAU,EAAA,QAAA,EAElBF,yBAAM,CAAC,EAAC,wFAAwF,EAAA,CAAG,EAAA,CAC3F;AAEd,CAAC;;ACpCD,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE;AAC/B,EAAE,KAAK,GAAG,KAAK,MAAM,GAAG,GAAG,GAAG,EAAE;AAChC,EAAE,IAAI,QAAQ,GAAG,GAAG,CAAC,QAAQ;;AAE7B,EAAE,IAAY,OAAO,QAAQ,KAAK,WAAW,EAAE,EAAE,OAAO,CAAC;;AAEzD,EAAE,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACtE,EAAE,IAAI,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC;AAC7C,EAAE,KAAK,CAAC,IAAI,GAAG,UAAU;;AAEzB,EAAE,IAAI,QAAQ,KAAK,KAAK,EAAE;AAC1B,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE;AACzB,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;AAC/C,IAAI,CAAC,MAAM;AACX,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC7B,IAAI;AACJ,EAAE,CAAC,MAAM;AACT,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC3B,EAAE;;AAEF,EAAE,IAAI,KAAK,CAAC,UAAU,EAAE;AACxB,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG;AAClC,EAAE,CAAC,MAAM;AACT,IAAI,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AACnD,EAAE;AACF;;;;;ACYA;;;;;;;;;;;AAWG;AACG,SAAU,mBAAmB,CACjC,UAAa,EAAA;AAIb,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,EAAEG,mBAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAG/F;AACH;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,uBAAuB,CAGrC,EACA,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,QAAQ,GAaT,EAAA;;AAEC,IAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,QAAA,OAAO,QAAQ,CAAC;;AAEd,YAAA,MAAM,EAAE,aAAsD;AAC9D,YAAA,UAAU,EAAE,iBAAiB;AAC9B,SAAA,CAAC;IACJ;;AAGA,IAAA,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;AACxC,QAAA,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;YAC5C,aAAa;YACb,iBAAiB;AAClB,SAAA,CAAC;QAEF,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IACzC;;AAGA,IAAA,OAAO,cAAc;AACvB;;ACrHA,MAAM,UAAU,GAAG,CAAiD,EAClE,QAAQ,EACR,QAAQ,GAAG,CAAC,EACZ,mBAAmB,GAAG,CAAC,EACvB,kBAAkB,GAAG,CAAC,EACtB,GAAG,gBAAgB,EAGiB,KAAI;IACxC,QACEH,cAAA,CAACI,oBAAW,EAAA,EAAA,GACN,gBAAgB,EACpB,SAAS,EAAC,gBAAgB,EAAA,YAAA,EACf,YAAY,EACvB,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,mBAAmB,EACxC,kBAAkB,EAAE,kBAAkB,EAAA,QAAA,EAErC,uBAAuB,CAAC;AACvB,YAAA,aAAa,EAAE,aAAa;AAC5B,YAAA,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmC;AAC/E,YAAA,cAAc,EAAE,QAAQ;AACxB,YAAA,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EAAE,UAAU,EAAE,KACjF;iBACG,MAAM,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,MAAM;AAC7B,iBAAA,GAAG,CAAY,CAAC,GAAG,EAAE,KAAK,KAAI;gBAC7B;;;gBAGEC,eAAA,CAAC,KAAK,CAAC,QAAQ,EAAA,EAAA,QAAA,EAAA,CACZ,KAAK,GAAG,CAAC,IAAI,iBAAiB,EAC9B,MAAM,CAAC,GAAG,CAAC,CAAA,EAAA,EAFO,CAAA,EAAG,KAAK,CAAA,WAAA,CAAa,CAGzB;AAErB,YAAA,CAAC,CAAC;SACP,CAAC,EAAA,CACU;AAElB;AAEA,UAAU,CAAC,iBAAiB,GAAG,iBAAiB;AAChD,UAAU,CAAC,cAAc,GAAG,cAAc;AAE1C,MAAM,aAAa,GAAG,mBAAmB,CAAC;AACxC,IAAA,iBAAiB,EAAE,iBAAiB;AACpC,IAAA,cAAc,EAAE,cAAc;AAC/B,CAAA,CAAC;;;;","x_google_ignoreList":[1]}
|
package/dist/index.esm.js
CHANGED
|
@@ -1,8 +1,25 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
if (typeof global === 'undefined') {
|
|
4
|
+
var global = window;
|
|
5
|
+
}
|
|
6
|
+
|
|
1
7
|
import { jsx, jsxs } from 'react/jsx-runtime';
|
|
2
|
-
import { createElement } from 'react';
|
|
8
|
+
import React, { createElement } from 'react';
|
|
9
|
+
import { useTheme, SvgIcon, Link, Breadcrumbs } from '@mui/material';
|
|
3
10
|
|
|
4
|
-
const BreadcrumbItem = ({ url, children, }) =>
|
|
5
|
-
const
|
|
11
|
+
const BreadcrumbItem = ({ url, children, }) => {
|
|
12
|
+
const theme = useTheme();
|
|
13
|
+
return (
|
|
14
|
+
// TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme
|
|
15
|
+
jsx(Link, { underline: "hover", color: "inherit", href: url, fontSize: theme.typography.caption.fontSize, fontWeight: theme.typography.caption.fontWeight, children: children }));
|
|
16
|
+
};
|
|
17
|
+
const BreadcrumbChevron = () => {
|
|
18
|
+
const theme = useTheme();
|
|
19
|
+
return (
|
|
20
|
+
// TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme
|
|
21
|
+
jsx(SvgIcon, { sx: { fontSize: theme.typography.caption.fontSize, color: theme.palette.primary.contrastText }, viewBox: "0 0 8 12", children: jsx("path", { d: "M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z" }) }));
|
|
22
|
+
};
|
|
6
23
|
|
|
7
24
|
function styleInject(css, ref) {
|
|
8
25
|
if ( ref === void 0 ) ref = {};
|
|
@@ -31,7 +48,7 @@ function styleInject(css, ref) {
|
|
|
31
48
|
}
|
|
32
49
|
}
|
|
33
50
|
|
|
34
|
-
var css_248z = ".nbb-breadcrumb {\n
|
|
51
|
+
var css_248z = ".nbb-breadcrumb.MuiBreadcrumbs-root {\n padding: calc(var(--mui-spacing) * 1.5) calc(var(--mui-spacing) * 2);\n background-color: var(--mui-palette-primary-main);\n color: var(--mui-palette-primary-contrastText);\n border-bottom: 1px solid rgba(255, 255, 255, 0.2);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-ol {\n gap: var(--mui-spacing);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-li {\n display: flex;\n align-items: center;\n gap: var(--mui-spacing);\n}\n\n.nbb-breadcrumb .MuiBreadcrumbs-separator {\n display: none;\n}\n";
|
|
35
52
|
styleInject(css_248z);
|
|
36
53
|
|
|
37
54
|
/**
|
|
@@ -47,10 +64,7 @@ styleInject(css_248z);
|
|
|
47
64
|
* });
|
|
48
65
|
*/
|
|
49
66
|
function createDefaultBlocks(components) {
|
|
50
|
-
return Object.fromEntries(Object.entries(components).map(([key, Component]) => [
|
|
51
|
-
key,
|
|
52
|
-
createElement(Component, { key }),
|
|
53
|
-
]));
|
|
67
|
+
return Object.fromEntries(Object.entries(components).map(([key, Component]) => [key, createElement(Component, { key })]));
|
|
54
68
|
}
|
|
55
69
|
/**
|
|
56
70
|
* A component for rendering {@link BlocksOverride|`BlocksOverride`} results.
|
|
@@ -74,6 +88,7 @@ function createDefaultBlocks(components) {
|
|
|
74
88
|
* </BlocksOverrideComponent>
|
|
75
89
|
*/
|
|
76
90
|
function BlocksOverrideComponent({ blocksOverride, defaultBlocks, defaultBlockOrder, children, }) {
|
|
91
|
+
// 1. standard "default" block use with no customization
|
|
77
92
|
if (blocksOverride === undefined) {
|
|
78
93
|
return children({
|
|
79
94
|
// TODO: Remove this assertion
|
|
@@ -81,30 +96,32 @@ function BlocksOverrideComponent({ blocksOverride, defaultBlocks, defaultBlockOr
|
|
|
81
96
|
blockOrder: defaultBlockOrder,
|
|
82
97
|
});
|
|
83
98
|
}
|
|
84
|
-
|
|
99
|
+
// 2.when user uses "child function" customization pattern, that returns the "override" object of blocks/blockOrder
|
|
100
|
+
if (typeof blocksOverride === 'function') {
|
|
85
101
|
const { blocks, blockOrder } = blocksOverride({
|
|
86
102
|
defaultBlocks,
|
|
87
103
|
defaultBlockOrder,
|
|
88
104
|
});
|
|
89
105
|
return children({ blocks, blockOrder });
|
|
90
106
|
}
|
|
107
|
+
// 3. when user uses "compound components" customization pattern, passing in their own chosen elements
|
|
91
108
|
return blocksOverride;
|
|
92
109
|
}
|
|
93
|
-
/**
|
|
94
|
-
* Utility function to join class names together, ignoring undefined or nil values.
|
|
95
|
-
* @param classes - The class names to join.
|
|
96
|
-
* @returns The joined class names.
|
|
97
|
-
*/
|
|
98
|
-
function classNames(...classes) {
|
|
99
|
-
return classes.flat().filter(Boolean).join(" ");
|
|
100
|
-
}
|
|
101
110
|
|
|
102
|
-
const Breadcrumb = ({
|
|
103
|
-
return (jsx(
|
|
111
|
+
const Breadcrumb = ({ children, maxItems = 8, itemsBeforeCollapse = 1, itemsAfterCollapse = 1, ...breadcrumbsProps }) => {
|
|
112
|
+
return (jsx(Breadcrumbs, { ...breadcrumbsProps, className: "nbb-breadcrumb", "aria-label": "breadcrumb", maxItems: maxItems, itemsBeforeCollapse: itemsBeforeCollapse, itemsAfterCollapse: itemsAfterCollapse, children: BlocksOverrideComponent({
|
|
113
|
+
defaultBlocks: defaultBlocks,
|
|
114
|
+
defaultBlockOrder: Object.keys(defaultBlocks),
|
|
115
|
+
blocksOverride: children,
|
|
116
|
+
children: ({ blocks: { breadcrumbChevron, breadcrumbItem, ...blocks }, blockOrder }) => blockOrder
|
|
104
117
|
.filter((key) => key in blocks)
|
|
105
118
|
.map((key, index) => {
|
|
106
|
-
return (
|
|
107
|
-
|
|
119
|
+
return (
|
|
120
|
+
// NOTE: the contents of this "children" property is only used for/rendered in the override child function "override" pattern
|
|
121
|
+
// for this to work, the user should pass in breadcrumbItem (or equivalent), and shouldn't pass in the breadcrumbChevron element to the blocks override object (since we append it here)
|
|
122
|
+
jsxs(React.Fragment, { children: [index > 0 && breadcrumbChevron, blocks[key]] }, `${index}-breadcrumb`));
|
|
123
|
+
}),
|
|
124
|
+
}) }));
|
|
108
125
|
};
|
|
109
126
|
Breadcrumb.BreadcrumbChevron = BreadcrumbChevron;
|
|
110
127
|
Breadcrumb.BreadcrumbItem = BreadcrumbItem;
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":["../src/blocks.tsx","../node_modules/style-inject/dist/style-inject.es.js","../src/lib.ts","../src/Breadcrumb.tsx"],"sourcesContent":["import { ComponentProps, ReactNode } from \"react\";\n\nexport const BreadcrumbItem = ({\n url,\n children,\n}: Omit<ComponentProps<\"a\">, \"children\"> & {\n url: string;\n children: ReactNode;\n}) => (\n <a href={url} className=\"nbb-breadcrumb-item\">\n {children}\n </a>\n);\n\nexport const BreadcrumbChevron = () => (\n <span className=\"nbb-breadcrumb-chevron\">\n <svg\n width=\"8\"\n height=\"12\"\n viewBox=\"0 0 8 12\"\n fill=\"none\"\n xmlns=\"http://www.w3.org/2000/svg\"\n >\n <path\n d=\"M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z\"\n fill=\"white\"\n />\n </svg>\n </span>\n);\n","function styleInject(css, ref) {\n if ( ref === void 0 ) ref = {};\n var insertAt = ref.insertAt;\n\n if (!css || typeof document === 'undefined') { return; }\n\n var head = document.head || document.getElementsByTagName('head')[0];\n var style = document.createElement('style');\n style.type = 'text/css';\n\n if (insertAt === 'top') {\n if (head.firstChild) {\n head.insertBefore(style, head.firstChild);\n } else {\n head.appendChild(style);\n }\n } else {\n head.appendChild(style);\n }\n\n if (style.styleSheet) {\n style.styleSheet.cssText = css;\n } else {\n style.appendChild(document.createTextNode(css));\n }\n}\n\nexport default styleInject;\n","import {\n ComponentProps,\n createElement,\n FunctionComponent,\n ReactElement,\n ReactNode,\n} from \"react\";\n\n/**\n * The function to be passed into a block component as `children` to selectively override default blocks, or just a `ReactNode`.\n *\n * @example\n * <Block>\n * {({header, ...defaultBlocks}) => ({\n * blocks: {\n * ...defaultBlocks,\n * header: {\n * ...header,\n * props: {\n * ...header.props,\n * label: \"Custom Label\"\n * }\n * },\n * subheader: <CustomComponent />\n * },\n * blockOrder: [\"header\", \"subheader\", \"body\", \"footer\"]\n * })}\n * </Block>\n */\nexport type BlocksOverride<DefaultBlocks, CustomBlocks> =\n | (({\n defaultBlocks,\n defaultBlockOrder,\n }: {\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: readonly (keyof DefaultBlocks)[];\n }) => {\n blocks: Partial<DefaultBlocks> & CustomBlocks;\n // NOTE: This specific combination allows proper autocomplete.\n blockOrder:\n | readonly (keyof DefaultBlocks)[]\n | readonly (keyof CustomBlocks)[];\n })\n | ReactNode;\n\n/**\n * Creates a strongly typed `defaultBlocks` object, allowing for types to propagate into block override objects.\n *\n * @param components - A map of default block keys to component functions.\n *\n * @example\n * const defaultBlocks = createDefaultBlocks({\n * title: Title,\n * description: Description,\n * form: Form,\n * });\n */\nexport function createDefaultBlocks<\n T extends Record<string, FunctionComponent<any>>,\n>(\n components: T\n): {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n} {\n return Object.fromEntries(\n Object.entries(components).map(([key, Component]) => [\n key,\n createElement(Component, { key }),\n ])\n ) as {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n };\n}\n\n/**\n * A component for rendering {@link BlocksOverride|`BlocksOverride`} results.\n * Exposes the evaluated `blocks` and `blockOrder` as arguments to the `children` function.\n *\n * @param props\n * @param props.blocksOverride - The {@link BlocksOverride|`BlocksOverride`} (i.e. `children` of outer component).\n * @param props.defaultBlocks - The default blocks of outer component.\n * @param props.children - A function returning the JSX to render.\n *\n * @example\n * <BlocksOverrideComponent\n * defaultBlocks={defaultFormBlocks}\n * blocksOverride={children}\n * >\n * {({ blocks, blockOrder }) =>\n * blockOrder.map((key) => (\n * <Fragment key={String(key)}>{blocks[key]}</Fragment>\n * ))\n * }\n * </BlocksOverrideComponent>\n */\nexport function BlocksOverrideComponent<\n DefaultBlocks extends Record<string, ReactNode>,\n CustomBlocks extends Record<string, ReactNode>,\n>({\n blocksOverride,\n defaultBlocks,\n defaultBlockOrder,\n children,\n}: {\n blocksOverride: BlocksOverride<DefaultBlocks, CustomBlocks>;\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: (keyof DefaultBlocks)[];\n children: ({\n blocks,\n blockOrder,\n }: {\n // TODO: Possibly find an alternative to Partial<CustomBlocks>\n blocks: Partial<DefaultBlocks> & Partial<CustomBlocks>;\n blockOrder: readonly (keyof DefaultBlocks | keyof CustomBlocks)[];\n }) => ReactNode;\n}) {\n if (blocksOverride === undefined) {\n return children({\n // TODO: Remove this assertion\n blocks: defaultBlocks as DefaultBlocks & Partial<CustomBlocks>,\n blockOrder: defaultBlockOrder,\n });\n }\n\n if (typeof blocksOverride === \"function\") {\n const { blocks, blockOrder } = blocksOverride({\n defaultBlocks,\n defaultBlockOrder,\n });\n\n return children({ blocks, blockOrder });\n }\n\n return blocksOverride;\n}\n\nexport function deepMerge<\n A extends Record<string, any>,\n B extends Record<string, any>,\n>(obj1: A, obj2: B) {\n const result: Record<string, any> = { ...obj1 };\n\n for (const key in obj2) {\n if (obj2.hasOwnProperty(key)) {\n const val1 = result[key];\n const val2 = obj2[key];\n\n if (Array.isArray(val1) || Array.isArray(val2)) {\n // If either is an array, replace entirely with obj2's value\n result[key] = val2;\n } else if (\n typeof val1 === \"object\" &&\n val1 !== null &&\n typeof val2 === \"object\" &&\n val2 !== null\n ) {\n result[key] = deepMerge(val1, val2);\n } else {\n result[key] = val2;\n }\n }\n }\n\n return result as A & B;\n}\n\ntype ClassName = string | ClassName[] | undefined | null;\n\n/**\n * Utility function to join class names together, ignoring undefined or nil values.\n * @param classes - The class names to join.\n * @returns The joined class names.\n */\nexport function classNames(...classes: ClassName[]): string {\n return classes.flat().filter(Boolean).join(\" \");\n}\n","import { ComponentProps, ReactNode } from \"react\";\nimport { BreadcrumbChevron, BreadcrumbItem } from \"./blocks\";\nimport \"./breadcrumb.css\";\nimport {\n BlocksOverride,\n BlocksOverrideComponent,\n classNames,\n createDefaultBlocks,\n} from \"./lib\";\n\nconst Breadcrumb = <CustomBlocks extends Record<string, ReactNode>>({\n className,\n children,\n}: Omit<ComponentProps<\"nav\">, \"children\"> & {\n children?: BlocksOverride<typeof defaultBlocks, CustomBlocks>;\n}) => {\n return (\n <nav className={classNames(\"nbb-breadcrumb\", className)}>\n <BlocksOverrideComponent\n defaultBlocks={defaultBlocks}\n defaultBlockOrder={\n Object.keys(defaultBlocks) as (keyof typeof defaultBlocks)[]\n }\n blocksOverride={children}\n >\n {({\n blocks: { breadcrumbChevron, breadcrumbItem, ...blocks },\n blockOrder,\n }) =>\n blockOrder\n .filter((key) => key in blocks)\n .map<ReactNode>((key, index) => {\n return (\n <span\n key={`${index}-breadcrumb`}\n className=\"nbb-breadcrumb-segment\"\n >\n {index > 0 && breadcrumbChevron}\n {blocks[key]}\n </span>\n );\n })\n }\n </BlocksOverrideComponent>\n </nav>\n );\n};\n\nBreadcrumb.BreadcrumbChevron = BreadcrumbChevron;\nBreadcrumb.BreadcrumbItem = BreadcrumbItem;\n\nconst defaultBlocks = createDefaultBlocks({\n breadcrumbChevron: BreadcrumbChevron,\n breadcrumbItem: BreadcrumbItem,\n});\n\nexport default Breadcrumb;\n"],"names":["_jsx","_jsxs"],"mappings":";;;AAEO,MAAM,cAAc,GAAG,CAAC,EAC7B,GAAG,EACH,QAAQ,GAIT,MACCA,GAAG,CAAA,GAAA,EAAA,EAAA,IAAI,EAAE,GAAG,EAAE,SAAS,EAAC,qBAAqB,EAC1C,QAAA,EAAA,QAAQ,EACP,CAAA,CACL;AAEM,MAAM,iBAAiB,GAAG,OAC/BA,GAAM,CAAA,MAAA,EAAA,EAAA,SAAS,EAAC,wBAAwB,EAAA,QAAA,EACtCA,aACE,KAAK,EAAC,GAAG,EACT,MAAM,EAAC,IAAI,EACX,OAAO,EAAC,UAAU,EAClB,IAAI,EAAC,MAAM,EACX,KAAK,EAAC,4BAA4B,EAElC,QAAA,EAAAA,GAAA,CAAA,MAAA,EAAA,EACE,CAAC,EAAC,wFAAwF,EAC1F,IAAI,EAAC,OAAO,EACZ,CAAA,EAAA,CACE,EACD,CAAA,CACR;;AC7BD,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE;AAC/B,EAAE,KAAK,GAAG,KAAK,MAAM,GAAG,GAAG,GAAG,EAAE;AAChC,EAAE,IAAI,QAAQ,GAAG,GAAG,CAAC,QAAQ;;AAE7B,EAAE,IAAY,OAAO,QAAQ,KAAK,WAAW,EAAE,EAAE,OAAO;;AAExD,EAAE,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACtE,EAAE,IAAI,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC;AAC7C,EAAE,KAAK,CAAC,IAAI,GAAG,UAAU;;AAEzB,EAAE,IAAI,QAAQ,KAAK,KAAK,EAAE;AAC1B,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE;AACzB,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;AAC/C,KAAK,MAAM;AACX,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC7B;AACA,GAAG,MAAM;AACT,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC3B;;AAEA,EAAE,IAAI,KAAK,CAAC,UAAU,EAAE;AACxB,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG;AAClC,GAAG,MAAM;AACT,IAAI,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AACnD;AACA;;;;;ACoBA;;;;;;;;;;;AAWG;AACG,SAAU,mBAAmB,CAGjC,UAAa,EAAA;IAIb,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK;QACnD,GAAG;AACH,QAAA,aAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC;AAClC,KAAA,CAAC,CAGH;AACH;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,uBAAuB,CAGrC,EACA,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,QAAQ,GAaT,EAAA;AACC,IAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,QAAA,OAAO,QAAQ,CAAC;;AAEd,YAAA,MAAM,EAAE,aAAsD;AAC9D,YAAA,UAAU,EAAE,iBAAiB;AAC9B,SAAA,CAAC;;AAGJ,IAAA,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;AACxC,QAAA,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;YAC5C,aAAa;YACb,iBAAiB;AAClB,SAAA,CAAC;QAEF,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;;AAGzC,IAAA,OAAO,cAAc;AACvB;AAkCA;;;;AAIG;AACa,SAAA,UAAU,CAAC,GAAG,OAAoB,EAAA;AAChD,IAAA,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AACjD;;ACrKM,MAAA,UAAU,GAAG,CAAiD,EAClE,SAAS,EACT,QAAQ,GAGT,KAAI;IACH,QACEA,aAAK,SAAS,EAAE,UAAU,CAAC,gBAAgB,EAAE,SAAS,CAAC,EAAA,QAAA,EACrDA,IAAC,uBAAuB,EAAA,EACtB,aAAa,EAAE,aAAa,EAC5B,iBAAiB,EACf,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmC,EAE9D,cAAc,EAAE,QAAQ,YAEvB,CAAC,EACA,MAAM,EAAE,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EACxD,UAAU,GACX,KACC;iBACG,MAAM,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,MAAM;AAC7B,iBAAA,GAAG,CAAY,CAAC,GAAG,EAAE,KAAK,KAAI;gBAC7B,QACEC,eAEE,SAAS,EAAC,wBAAwB,EAEjC,QAAA,EAAA,CAAA,KAAK,GAAG,CAAC,IAAI,iBAAiB,EAC9B,MAAM,CAAC,GAAG,CAAC,CAAA,EAAA,EAJP,GAAG,KAAK,CAAA,WAAA,CAAa,CAKrB;AAEX,aAAC,CAAC,EAAA,CAEkB,EACtB,CAAA;AAEV;AAEA,UAAU,CAAC,iBAAiB,GAAG,iBAAiB;AAChD,UAAU,CAAC,cAAc,GAAG,cAAc;AAE1C,MAAM,aAAa,GAAG,mBAAmB,CAAC;AACxC,IAAA,iBAAiB,EAAE,iBAAiB;AACpC,IAAA,cAAc,EAAE,cAAc;AAC/B,CAAA,CAAC;;;;","x_google_ignoreList":[1]}
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":["../src/blocks.tsx","../node_modules/style-inject/dist/style-inject.es.js","../src/lib.ts","../src/Breadcrumb.tsx"],"sourcesContent":["import { ComponentProps, ReactNode } from 'react';\nimport { Link, SvgIcon, useTheme } from '@mui/material';\n\nexport const BreadcrumbItem = ({\n url,\n children,\n}: Omit<ComponentProps<'a'>, 'children'> & {\n url: string;\n children: ReactNode;\n}) => {\n const theme = useTheme();\n return (\n // TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme\n <Link\n underline=\"hover\"\n color=\"inherit\"\n href={url}\n fontSize={theme.typography.caption.fontSize}\n fontWeight={theme.typography.caption.fontWeight}\n >\n {children}\n </Link>\n );\n};\n\nexport const BreadcrumbChevron = () => {\n const theme = useTheme();\n return (\n // TODO: this is hardcoded for now until we setup the theme - then go back and use variables from the theme\n <SvgIcon\n sx={{ fontSize: theme.typography.caption.fontSize, color: theme.palette.primary.contrastText }}\n viewBox=\"0 0 8 12\"\n >\n <path d=\"M0.294922 10.59L4.87492 6L0.294922 1.41L1.70492 0L7.70492 6L1.70492 12L0.294922 10.59Z\" />\n </SvgIcon>\n );\n};\n","function styleInject(css, ref) {\n if ( ref === void 0 ) ref = {};\n var insertAt = ref.insertAt;\n\n if (!css || typeof document === 'undefined') { return; }\n\n var head = document.head || document.getElementsByTagName('head')[0];\n var style = document.createElement('style');\n style.type = 'text/css';\n\n if (insertAt === 'top') {\n if (head.firstChild) {\n head.insertBefore(style, head.firstChild);\n } else {\n head.appendChild(style);\n }\n } else {\n head.appendChild(style);\n }\n\n if (style.styleSheet) {\n style.styleSheet.cssText = css;\n } else {\n style.appendChild(document.createTextNode(css));\n }\n}\n\nexport default styleInject;\n","import { ComponentProps, createElement, FunctionComponent, ReactElement, ReactNode } from 'react';\n\n/**\n * The function to be passed into a block component as `children` to selectively override default blocks, or just a `ReactNode`.\n *\n * @example\n * <Block>\n * {({ defaultBlocks: { header, ...defaultBlocks }, defaultBlockOrder }) => ({\n * blocks: {\n * ...defaultBlocks,\n * header: {\n * ...header,\n * props: {\n * ...header.props,\n * label: \"Custom Label\"\n * }\n * },\n * subheader: <CustomComponent />\n * },\n * blockOrder: [\"header\", \"subheader\", \"body\", \"footer\"]\n * })}\n * </Block>\n */\nexport type BlocksOverride<DefaultBlocks, CustomBlocks> =\n | (({\n defaultBlocks,\n defaultBlockOrder,\n }: {\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: readonly (keyof DefaultBlocks)[];\n }) => {\n blocks: Partial<DefaultBlocks> & CustomBlocks;\n // NOTE: This specific combination allows proper autocomplete.\n blockOrder: readonly (keyof DefaultBlocks)[] | readonly (keyof CustomBlocks)[];\n })\n | ReactNode;\n\n/**\n * Creates a strongly typed `defaultBlocks` object, allowing for types to propagate into block override objects.\n *\n * @param components - A map of default block keys to component functions.\n *\n * @example\n * const defaultBlocks = createDefaultBlocks({\n * title: Title,\n * description: Description,\n * form: Form,\n * });\n */\nexport function createDefaultBlocks<T extends Record<string, FunctionComponent<any>>>(\n components: T\n): {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n} {\n return Object.fromEntries(\n Object.entries(components).map(([key, Component]) => [key, createElement(Component, { key })])\n ) as {\n [K in keyof T]: ReactElement<ComponentProps<T[K]>, T[K]>;\n };\n}\n\n/**\n * A component for rendering {@link BlocksOverride|`BlocksOverride`} results.\n * Exposes the evaluated `blocks` and `blockOrder` as arguments to the `children` function.\n *\n * @param props\n * @param props.blocksOverride - The {@link BlocksOverride|`BlocksOverride`} (i.e. `children` of outer component).\n * @param props.defaultBlocks - The default blocks of outer component.\n * @param props.children - A function returning the JSX to render.\n *\n * @example\n * <BlocksOverrideComponent\n * defaultBlocks={defaultFormBlocks}\n * blocksOverride={children}\n * >\n * {({ blocks, blockOrder }) =>\n * blockOrder.map((key) => (\n * <Fragment key={String(key)}>{blocks[key]}</Fragment>\n * ))\n * }\n * </BlocksOverrideComponent>\n */\nexport function BlocksOverrideComponent<\n DefaultBlocks extends Record<string, ReactNode>,\n CustomBlocks extends Record<string, ReactNode>,\n>({\n blocksOverride,\n defaultBlocks,\n defaultBlockOrder,\n children,\n}: {\n blocksOverride: BlocksOverride<DefaultBlocks, CustomBlocks>;\n defaultBlocks: DefaultBlocks;\n defaultBlockOrder: (keyof DefaultBlocks)[];\n children: ({\n blocks,\n blockOrder,\n }: {\n // TODO: Possibly find an alternative to Partial<CustomBlocks>\n blocks: Partial<DefaultBlocks> & Partial<CustomBlocks>;\n blockOrder: readonly (keyof DefaultBlocks | keyof CustomBlocks)[];\n }) => ReactNode;\n}) {\n // 1. standard \"default\" block use with no customization\n if (blocksOverride === undefined) {\n return children({\n // TODO: Remove this assertion\n blocks: defaultBlocks as DefaultBlocks & Partial<CustomBlocks>,\n blockOrder: defaultBlockOrder,\n });\n }\n\n // 2.when user uses \"child function\" customization pattern, that returns the \"override\" object of blocks/blockOrder\n if (typeof blocksOverride === 'function') {\n const { blocks, blockOrder } = blocksOverride({\n defaultBlocks,\n defaultBlockOrder,\n });\n\n return children({ blocks, blockOrder });\n }\n\n // 3. when user uses \"compound components\" customization pattern, passing in their own chosen elements\n return blocksOverride;\n}\n\ntype MergeTypes<Object1, Object2> = {\n [K in keyof Object1 | keyof Object2]: K extends keyof Object1\n ? Object1[K]\n : K extends keyof Object2\n ? Object2[K]\n : never;\n};\n\nexport function deepMerge<A extends Record<string, any>, B extends Record<string, any>>(obj1: A, obj2: B) {\n const result: Record<string, any> = { ...obj1 };\n\n for (const key in obj2) {\n if (obj2.hasOwnProperty(key)) {\n const val1 = result[key];\n const val2 = obj2[key];\n\n if (Array.isArray(val1) || Array.isArray(val2)) {\n // If either is an array, replace entirely with obj2's value\n result[key] = val2;\n } else if (typeof val1 === 'object' && val1 !== null && typeof val2 === 'object' && val2 !== null) {\n result[key] = deepMerge(val1, val2);\n } else {\n result[key] = val2;\n }\n }\n }\n\n return result as MergeTypes<B, A>;\n}\n\ntype ClassName = string | ClassName[] | undefined | null;\n\n/**\n * Utility function to join class names together, ignoring undefined or nil values.\n * @param classes - The class names to join.\n * @returns The joined class names.\n */\nexport function classNames(...classes: ClassName[]): string {\n return classes.flat().filter(Boolean).join(' ');\n}\n","import { ComponentProps, ReactNode } from 'react';\nimport React from 'react';\nimport { BreadcrumbChevron, BreadcrumbItem } from './blocks';\nimport './breadcrumb.css';\nimport { BlocksOverride, BlocksOverrideComponent, createDefaultBlocks } from './lib';\nimport { Breadcrumbs, BreadcrumbsProps } from '@mui/material';\n\nconst Breadcrumb = <CustomBlocks extends Record<string, ReactNode>>({\n children,\n maxItems = 8,\n itemsBeforeCollapse = 1,\n itemsAfterCollapse = 1,\n ...breadcrumbsProps\n}: {\n children?: BlocksOverride<typeof defaultBlocks, CustomBlocks>;\n} & Omit<BreadcrumbsProps, 'children'>) => {\n return (\n <Breadcrumbs\n {...breadcrumbsProps}\n className=\"nbb-breadcrumb\"\n aria-label=\"breadcrumb\"\n maxItems={maxItems}\n itemsBeforeCollapse={itemsBeforeCollapse}\n itemsAfterCollapse={itemsAfterCollapse}\n >\n {BlocksOverrideComponent({\n defaultBlocks: defaultBlocks,\n defaultBlockOrder: Object.keys(defaultBlocks) as (keyof typeof defaultBlocks)[],\n blocksOverride: children,\n children: ({ blocks: { breadcrumbChevron, breadcrumbItem, ...blocks }, blockOrder }) =>\n blockOrder\n .filter((key) => key in blocks)\n .map<ReactNode>((key, index) => {\n return (\n // NOTE: the contents of this \"children\" property is only used for/rendered in the override child function \"override\" pattern\n // for this to work, the user should pass in breadcrumbItem (or equivalent), and shouldn't pass in the breadcrumbChevron element to the blocks override object (since we append it here)\n <React.Fragment key={`${index}-breadcrumb`}>\n {index > 0 && breadcrumbChevron}\n {blocks[key]}\n </React.Fragment>\n );\n }),\n })}\n </Breadcrumbs>\n );\n};\n\nBreadcrumb.BreadcrumbChevron = BreadcrumbChevron;\nBreadcrumb.BreadcrumbItem = BreadcrumbItem;\n\nconst defaultBlocks = createDefaultBlocks({\n breadcrumbChevron: BreadcrumbChevron,\n breadcrumbItem: BreadcrumbItem,\n});\n\nexport default Breadcrumb;\n"],"names":["_jsx","_jsxs"],"mappings":";;;;;;;;;;AAGO,MAAM,cAAc,GAAG,CAAC,EAC7B,GAAG,EACH,QAAQ,GAIT,KAAI;AACH,IAAA,MAAM,KAAK,GAAG,QAAQ,EAAE;IACxB;;AAEE,IAAAA,GAAA,CAAC,IAAI,EAAA,EACH,SAAS,EAAC,OAAO,EACjB,KAAK,EAAC,SAAS,EACf,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAC3C,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,YAE9C,QAAQ,EAAA,CACJ;AAEX,CAAC;AAEM,MAAM,iBAAiB,GAAG,MAAK;AACpC,IAAA,MAAM,KAAK,GAAG,QAAQ,EAAE;IACxB;;AAEE,IAAAA,GAAA,CAAC,OAAO,EAAA,EACN,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,EAC9F,OAAO,EAAC,UAAU,EAAA,QAAA,EAElBA,cAAM,CAAC,EAAC,wFAAwF,EAAA,CAAG,EAAA,CAC3F;AAEd,CAAC;;ACpCD,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE;AAC/B,EAAE,KAAK,GAAG,KAAK,MAAM,GAAG,GAAG,GAAG,EAAE;AAChC,EAAE,IAAI,QAAQ,GAAG,GAAG,CAAC,QAAQ;;AAE7B,EAAE,IAAY,OAAO,QAAQ,KAAK,WAAW,EAAE,EAAE,OAAO,CAAC;;AAEzD,EAAE,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACtE,EAAE,IAAI,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC;AAC7C,EAAE,KAAK,CAAC,IAAI,GAAG,UAAU;;AAEzB,EAAE,IAAI,QAAQ,KAAK,KAAK,EAAE;AAC1B,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE;AACzB,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;AAC/C,IAAI,CAAC,MAAM;AACX,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC7B,IAAI;AACJ,EAAE,CAAC,MAAM;AACT,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;AAC3B,EAAE;;AAEF,EAAE,IAAI,KAAK,CAAC,UAAU,EAAE;AACxB,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG;AAClC,EAAE,CAAC,MAAM;AACT,IAAI,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AACnD,EAAE;AACF;;;;;ACYA;;;;;;;;;;;AAWG;AACG,SAAU,mBAAmB,CACjC,UAAa,EAAA;AAIb,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAG/F;AACH;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,uBAAuB,CAGrC,EACA,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,QAAQ,GAaT,EAAA;;AAEC,IAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,QAAA,OAAO,QAAQ,CAAC;;AAEd,YAAA,MAAM,EAAE,aAAsD;AAC9D,YAAA,UAAU,EAAE,iBAAiB;AAC9B,SAAA,CAAC;IACJ;;AAGA,IAAA,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;AACxC,QAAA,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC;YAC5C,aAAa;YACb,iBAAiB;AAClB,SAAA,CAAC;QAEF,OAAO,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IACzC;;AAGA,IAAA,OAAO,cAAc;AACvB;;ACrHA,MAAM,UAAU,GAAG,CAAiD,EAClE,QAAQ,EACR,QAAQ,GAAG,CAAC,EACZ,mBAAmB,GAAG,CAAC,EACvB,kBAAkB,GAAG,CAAC,EACtB,GAAG,gBAAgB,EAGiB,KAAI;IACxC,QACEA,GAAA,CAAC,WAAW,EAAA,EAAA,GACN,gBAAgB,EACpB,SAAS,EAAC,gBAAgB,EAAA,YAAA,EACf,YAAY,EACvB,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,mBAAmB,EACxC,kBAAkB,EAAE,kBAAkB,EAAA,QAAA,EAErC,uBAAuB,CAAC;AACvB,YAAA,aAAa,EAAE,aAAa;AAC5B,YAAA,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmC;AAC/E,YAAA,cAAc,EAAE,QAAQ;AACxB,YAAA,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EAAE,UAAU,EAAE,KACjF;iBACG,MAAM,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,MAAM;AAC7B,iBAAA,GAAG,CAAY,CAAC,GAAG,EAAE,KAAK,KAAI;gBAC7B;;;gBAGEC,IAAA,CAAC,KAAK,CAAC,QAAQ,EAAA,EAAA,QAAA,EAAA,CACZ,KAAK,GAAG,CAAC,IAAI,iBAAiB,EAC9B,MAAM,CAAC,GAAG,CAAC,CAAA,EAAA,EAFO,CAAA,EAAG,KAAK,CAAA,WAAA,CAAa,CAGzB;AAErB,YAAA,CAAC,CAAC;SACP,CAAC,EAAA,CACU;AAElB;AAEA,UAAU,CAAC,iBAAiB,GAAG,iBAAiB;AAChD,UAAU,CAAC,cAAc,GAAG,cAAc;AAE1C,MAAM,aAAa,GAAG,mBAAmB,CAAC;AACxC,IAAA,iBAAiB,EAAE,iBAAiB;AACpC,IAAA,cAAc,EAAE,cAAc;AAC/B,CAAA,CAAC;;;;","x_google_ignoreList":[1]}
|
package/dist/lib.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { ComponentProps, FunctionComponent, ReactElement, ReactNode } from
|
|
1
|
+
import { ComponentProps, FunctionComponent, ReactElement, ReactNode } from 'react';
|
|
2
2
|
/**
|
|
3
3
|
* The function to be passed into a block component as `children` to selectively override default blocks, or just a `ReactNode`.
|
|
4
4
|
*
|
|
5
5
|
* @example
|
|
6
6
|
* <Block>
|
|
7
|
-
* {({header, ...defaultBlocks}) => ({
|
|
7
|
+
* {({ defaultBlocks: { header, ...defaultBlocks }, defaultBlockOrder }) => ({
|
|
8
8
|
* blocks: {
|
|
9
9
|
* ...defaultBlocks,
|
|
10
10
|
* header: {
|
|
@@ -72,7 +72,10 @@ export declare function BlocksOverrideComponent<DefaultBlocks extends Record<str
|
|
|
72
72
|
blockOrder: readonly (keyof DefaultBlocks | keyof CustomBlocks)[];
|
|
73
73
|
}) => ReactNode;
|
|
74
74
|
}): ReactNode;
|
|
75
|
-
|
|
75
|
+
type MergeTypes<Object1, Object2> = {
|
|
76
|
+
[K in keyof Object1 | keyof Object2]: K extends keyof Object1 ? Object1[K] : K extends keyof Object2 ? Object2[K] : never;
|
|
77
|
+
};
|
|
78
|
+
export declare function deepMerge<A extends Record<string, any>, B extends Record<string, any>>(obj1: A, obj2: B): MergeTypes<B, A>;
|
|
76
79
|
type ClassName = string | ClassName[] | undefined | null;
|
|
77
80
|
/**
|
|
78
81
|
* Utility function to join class names together, ignoring undefined or nil values.
|
package/dist/lib.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAiB,iBAAiB,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElG;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,cAAc,CAAC,aAAa,EAAE,YAAY,IAClD,CAAC,CAAC,EACA,aAAa,EACb,iBAAiB,GAClB,EAAE;IACD,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,SAAS,CAAC,MAAM,aAAa,CAAC,EAAE,CAAC;CACrD,KAAK;IACJ,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,YAAY,CAAC;IAE9C,UAAU,EAAE,SAAS,CAAC,MAAM,aAAa,CAAC,EAAE,GAAG,SAAS,CAAC,MAAM,YAAY,CAAC,EAAE,CAAC;CAChF,CAAC,GACF,SAAS,CAAC;AAEd;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAClF,UAAU,EAAE,CAAC,GACZ;KACA,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CACzD,CAMA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAC/C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAC9C,EACA,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,QAAQ,GACT,EAAE;IACD,cAAc,EAAE,cAAc,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IAC5D,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,EAAE,CAAC,MAAM,aAAa,CAAC,EAAE,CAAC;IAC3C,QAAQ,EAAE,CAAC,EACT,MAAM,EACN,UAAU,GACX,EAAE;QAED,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;QACvD,UAAU,EAAE,SAAS,CAAC,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC;KACnE,KAAK,SAAS,CAAC;CACjB,aAsBA;AAED,KAAK,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI;KACjC,CAAC,IAAI,MAAM,OAAO,GAAG,MAAM,OAAO,GAAG,CAAC,SAAS,MAAM,OAAO,GACzD,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,MAAM,OAAO,GACrB,OAAO,CAAC,CAAC,CAAC,GACV,KAAK;CACZ,CAAC;AAEF,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAmBrF,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAClC;AAED,KAAK,SAAS,GAAG,MAAM,GAAG,SAAS,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC;AAEzD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAE1D"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nodeblocks/frontend-breadcrumb-block",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"main": "dist/index.cjs.js",
|
|
5
5
|
"module": "dist/index.esm.js",
|
|
6
6
|
"browser": "dist/index.iife.js",
|
|
@@ -11,21 +11,25 @@
|
|
|
11
11
|
],
|
|
12
12
|
"scripts": {
|
|
13
13
|
"build": "rollup -c",
|
|
14
|
-
"watch": "rollup -c --watch"
|
|
14
|
+
"watch": "rm -rf dist && cross-env NODE_ENV=development rollup -c --watch"
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
|
-
"react": "
|
|
18
|
-
"react-dom": "
|
|
17
|
+
"react": ">=18 <20",
|
|
18
|
+
"react-dom": ">=18 <20",
|
|
19
|
+
"@mui/material": "^7.3.4",
|
|
20
|
+
"@emotion/react": "^11.14.0",
|
|
21
|
+
"@emotion/styled": "^11.14.1"
|
|
19
22
|
},
|
|
20
23
|
"devDependencies": {
|
|
21
|
-
"@rollup/plugin-commonjs": "^28.0.
|
|
24
|
+
"@rollup/plugin-commonjs": "^28.0.6",
|
|
22
25
|
"@rollup/plugin-json": "^6.1.0",
|
|
23
26
|
"@rollup/plugin-node-resolve": "^15.3.0",
|
|
24
27
|
"@rollup/plugin-typescript": "^12.1.1",
|
|
25
|
-
"@types/react": "
|
|
26
|
-
"@types/react-dom": "
|
|
28
|
+
"@types/react": "19.2.7",
|
|
29
|
+
"@types/react-dom": "19.2.3",
|
|
27
30
|
"rollup": "^4.28.0",
|
|
28
31
|
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
32
|
+
"rollup-plugin-polyfill-node": "^0.13.0",
|
|
29
33
|
"rollup-plugin-postcss": "^4.0.2",
|
|
30
34
|
"rollup-plugin-serve": "^1.1.1",
|
|
31
35
|
"tslib": "^2.8.1",
|
package/readme.md
CHANGED
|
@@ -3,24 +3,29 @@
|
|
|
3
3
|
Welcome to the Nodeblocks Frontend Starter Kit! 🎉 This kit is designed to make building frontend libraries in React super easy, helping you streamline your development workflow with minimal fuss. Let's dive in! 🤿
|
|
4
4
|
|
|
5
5
|
### ✨ Features
|
|
6
|
+
|
|
6
7
|
- **🚀 Bundling with Rollup:** Get a clean, minimalistic approach to bundling your JavaScript files for smoother frontend development.
|
|
7
8
|
- **💙 TypeScript Support:** We've included a pre-configured `tsconfig.json` to ensure your TypeScript setup is strict, efficient, and ready to go.
|
|
8
9
|
- **⚙️ Peer Dependencies:** Keep bundle sizes lean with React and React DOM set as peer dependencies.
|
|
9
10
|
- **🎨 CSS Support:** Easily import and process CSS files, giving you more control over your styles.
|
|
10
11
|
|
|
11
12
|
### 🛠️ How to Use
|
|
13
|
+
|
|
12
14
|
1. **Clone this repository** 🌀:
|
|
15
|
+
|
|
13
16
|
```bash
|
|
14
17
|
git clone <repository-url>
|
|
15
18
|
cd <repository-directory>
|
|
16
19
|
```
|
|
17
20
|
|
|
18
21
|
2. **Install dependencies** 📦:
|
|
22
|
+
|
|
19
23
|
```bash
|
|
20
24
|
npm install
|
|
21
25
|
```
|
|
22
26
|
|
|
23
27
|
3. **Start development** 🛠️:
|
|
28
|
+
|
|
24
29
|
```bash
|
|
25
30
|
npm run watch
|
|
26
31
|
```
|
|
@@ -48,10 +53,12 @@ This ensures Nodeblocks libraries integrate seamlessly with different workflows.
|
|
|
48
53
|
npm link
|
|
49
54
|
```
|
|
50
55
|
2. In the test project you want to run:
|
|
56
|
+
|
|
51
57
|
```bash
|
|
52
58
|
npm i
|
|
53
59
|
npm link @basaldev/frontend-starter-kit
|
|
54
60
|
```
|
|
55
|
-
(Note that in real life your library would not be called frontend-starter-kit.)
|
|
56
61
|
|
|
57
|
-
|
|
62
|
+
(Note that in real life your library would not be called frontend-starter-kit.)
|
|
63
|
+
|
|
64
|
+
3. Then you can follow your usual workflow either with **Create React App** (`npm start`) or with Vite (`npm run dev`). This will give you a development environment where whenever you change your library it will be available in your test project.
|