@san-siva/blogkit 1.1.43 → 1.1.45
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/cjs/components/Blog.js +4 -1
- package/dist/cjs/components/Blog.js.map +1 -1
- package/dist/cjs/components/Checkbox.js +14 -0
- package/dist/cjs/components/Checkbox.js.map +1 -0
- package/dist/cjs/components/WidthModeToggle.js +18 -0
- package/dist/cjs/components/WidthModeToggle.js.map +1 -0
- package/dist/cjs/context/WidthModeContext.js +23 -0
- package/dist/cjs/context/WidthModeContext.js.map +1 -0
- package/dist/cjs/index.css +1 -1
- package/dist/cjs/index.css.map +1 -1
- package/dist/cjs/index.js +2 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/staticComponents/CheckListStatic.js +2 -1
- package/dist/cjs/staticComponents/CheckListStatic.js.map +1 -1
- package/dist/esm/components/Blog.js +4 -1
- package/dist/esm/components/Blog.js.map +1 -1
- package/dist/esm/components/Checkbox.js +10 -0
- package/dist/esm/components/Checkbox.js.map +1 -0
- package/dist/esm/components/WidthModeToggle.js +14 -0
- package/dist/esm/components/WidthModeToggle.js.map +1 -0
- package/dist/esm/context/WidthModeContext.js +20 -0
- package/dist/esm/context/WidthModeContext.js.map +1 -0
- package/dist/esm/index.css +1 -1
- package/dist/esm/index.css.map +1 -1
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/staticComponents/CheckListStatic.js +2 -1
- package/dist/esm/staticComponents/CheckListStatic.js.map +1 -1
- package/dist/types/components/Blog.d.ts +2 -1
- package/dist/types/components/Blog.d.ts.map +1 -1
- package/dist/types/components/Blog.test.d.ts +2 -0
- package/dist/types/components/Blog.test.d.ts.map +1 -0
- package/dist/types/components/Checkbox.d.ts +7 -0
- package/dist/types/components/Checkbox.d.ts.map +1 -0
- package/dist/types/components/Checkbox.test.d.ts +2 -0
- package/dist/types/components/Checkbox.test.d.ts.map +1 -0
- package/dist/types/components/WidthModeToggle.d.ts +3 -0
- package/dist/types/components/WidthModeToggle.d.ts.map +1 -0
- package/dist/types/context/WidthModeContext.d.ts +12 -0
- package/dist/types/context/WidthModeContext.d.ts.map +1 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/staticComponents/CheckListStatic.d.ts +1 -0
- package/dist/types/staticComponents/CheckListStatic.d.ts.map +1 -1
- package/dist/types/staticComponents/CheckListStatic.test.d.ts +2 -0
- package/dist/types/staticComponents/CheckListStatic.test.d.ts.map +1 -0
- package/package.json +1 -1
- package/src/components/Blog.test.tsx +40 -0
- package/src/components/Blog.tsx +16 -1
- package/src/components/Checkbox.test.tsx +32 -0
- package/src/components/Checkbox.tsx +24 -0
- package/src/index.ts +1 -0
- package/src/staticComponents/CheckListStatic.test.tsx +29 -0
- package/src/staticComponents/CheckListStatic.tsx +3 -5
- package/src/styles/CheckList.module.scss +1 -0
package/dist/esm/index.js
CHANGED
|
@@ -7,5 +7,6 @@ export { default as Mermaid } from './components/Mermaid.js';
|
|
|
7
7
|
export { default as BlogLink } from './components/BlogLink.js';
|
|
8
8
|
export { default as Table } from './components/Table.js';
|
|
9
9
|
export { default as CheckList } from './components/CheckList.js';
|
|
10
|
+
export { default as Checkbox } from './components/Checkbox.js';
|
|
10
11
|
export { generateIdForBlogTitle, generateUrlForBlogTitle } from './utils/index.js';
|
|
11
12
|
//# sourceMappingURL=index.js.map
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { jsx, jsxs } from 'react/jsx-runtime';
|
|
2
|
+
import Checkbox from '../components/Checkbox.js';
|
|
2
3
|
import styles from '../styles/CheckList.module.scss.js';
|
|
3
4
|
|
|
4
5
|
const CheckListStatic = ({ items, hasMarginUp = false, hasMarginDown = false, }) => {
|
|
5
|
-
return (jsx("div", { className: `${styles['check-list']} ${hasMarginUp ? styles['margin-top--1'] : ''} ${hasMarginDown ? styles['margin-bottom--2'] : ''}`, children: items.map((item) => (jsxs("div", { className: styles['check-list__item'], "data-id": item.id, children: [jsx(
|
|
6
|
+
return (jsx("div", { className: `${styles['check-list']} ${hasMarginUp ? styles['margin-top--1'] : ''} ${hasMarginDown ? styles['margin-bottom--2'] : ''}`, children: items.map((item) => (jsxs("div", { className: styles['check-list__item'], "data-id": item.id, children: [jsx(Checkbox, { isChecked: item.isChecked, onClick: item.onClick }), item.children] }, item.id))) }));
|
|
6
7
|
};
|
|
7
8
|
|
|
8
9
|
export { CheckListStatic as default };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CheckListStatic.js","sources":["../../../src/staticComponents/CheckListStatic.tsx"],"sourcesContent":["import type { HTMLAttributes, ReactElement } from 'react';\n\nimport styles from '../styles/CheckList.module.scss';\n\nexport interface CheckListItem {\n\tid: string;\n\tchildren: ReactElement<HTMLAttributes<HTMLParagraphElement>, 'p'>;\n\tisChecked?: boolean;\n}\n\ninterface CheckListProperties {\n\titems: CheckListItem[];\n\thasMarginUp?: boolean;\n\thasMarginDown?: boolean;\n}\n\nconst CheckListStatic = ({\n\titems,\n\thasMarginUp = false,\n\thasMarginDown = false,\n}: CheckListProperties) => {\n\treturn (\n\t\t<div\n\t\t\tclassName={`${styles['check-list']} ${hasMarginUp ? styles['margin-top--1'] : ''} ${\n\t\t\t\thasMarginDown ? styles['margin-bottom--2'] : ''\n\t\t\t}`}\n\t\t>\n\t\t\t{items.map((item) => (\n\t\t\t\t<div key={item.id} className={styles['check-list__item']} data-id={item.id}>\n\t\t\t\t\t<
|
|
1
|
+
{"version":3,"file":"CheckListStatic.js","sources":["../../../src/staticComponents/CheckListStatic.tsx"],"sourcesContent":["import type { HTMLAttributes, ReactElement } from 'react';\n\nimport Checkbox from '../components/Checkbox';\nimport styles from '../styles/CheckList.module.scss';\n\nexport interface CheckListItem {\n\tid: string;\n\tchildren: ReactElement<HTMLAttributes<HTMLParagraphElement>, 'p'>;\n\tisChecked?: boolean;\n\tonClick?: () => void;\n}\n\ninterface CheckListProperties {\n\titems: CheckListItem[];\n\thasMarginUp?: boolean;\n\thasMarginDown?: boolean;\n}\n\nconst CheckListStatic = ({\n\titems,\n\thasMarginUp = false,\n\thasMarginDown = false,\n}: CheckListProperties) => {\n\treturn (\n\t\t<div\n\t\t\tclassName={`${styles['check-list']} ${hasMarginUp ? styles['margin-top--1'] : ''} ${\n\t\t\t\thasMarginDown ? styles['margin-bottom--2'] : ''\n\t\t\t}`}\n\t\t>\n\t\t\t{items.map((item) => (\n\t\t\t\t<div key={item.id} className={styles['check-list__item']} data-id={item.id}>\n\t\t\t\t\t<Checkbox isChecked={item.isChecked} onClick={item.onClick} />\n\t\t\t\t\t{item.children}\n\t\t\t\t</div>\n\t\t\t))}\n\t\t</div>\n\t);\n};\n\nexport default CheckListStatic;\n"],"names":["_jsx","_jsxs"],"mappings":";;;;AAkBA,MAAM,eAAe,GAAG,CAAC,EACxB,KAAK,EACL,WAAW,GAAG,KAAK,EACnB,aAAa,GAAG,KAAK,GACA,KAAI;AACzB,IAAA,QACCA,GAAA,CAAA,KAAA,EAAA,EACC,SAAS,EAAE,CAAA,EAAG,MAAM,CAAC,YAAY,CAAC,CAAA,CAAA,EAAI,WAAW,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAC/E,aAAa,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAC9C,CAAA,CAAE,EAAA,QAAA,EAED,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,MACfC,IAAA,CAAA,KAAA,EAAA,EAAmB,SAAS,EAAE,MAAM,CAAC,kBAAkB,CAAC,aAAW,IAAI,CAAC,EAAE,EAAA,QAAA,EAAA,CACzED,GAAA,CAAC,QAAQ,EAAA,EAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAA,CAAI,EAC7D,IAAI,CAAC,QAAQ,CAAA,EAAA,EAFL,IAAI,CAAC,EAAE,CAGX,CACN,CAAC,EAAA,CACG;AAER;;;;"}
|
|
@@ -5,7 +5,8 @@ interface BlogProperties {
|
|
|
5
5
|
title?: string;
|
|
6
6
|
jsonLd?: WithContext<Thing>;
|
|
7
7
|
increasedWidthMode?: boolean;
|
|
8
|
+
isTocEnabled?: boolean;
|
|
8
9
|
}
|
|
9
|
-
declare const Blog: ({ children, title, jsonLd, increasedWidthMode }: BlogProperties) => import("react").JSX.Element;
|
|
10
|
+
declare const Blog: ({ children, title, jsonLd, increasedWidthMode, isTocEnabled, }: BlogProperties) => import("react").JSX.Element;
|
|
10
11
|
export default Blog;
|
|
11
12
|
//# sourceMappingURL=Blog.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Blog.d.ts","sourceRoot":"","sources":["../../../src/components/Blog.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKrD,UAAU,cAAc;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,kBAAkB,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"Blog.d.ts","sourceRoot":"","sources":["../../../src/components/Blog.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKrD,UAAU,cAAc;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,QAAA,MAAM,IAAI,GAAI,gEAMX,cAAc,gCAchB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Blog.test.d.ts","sourceRoot":"","sources":["../../../src/components/Blog.test.tsx"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Checkbox.d.ts","sourceRoot":"","sources":["../../../src/components/Checkbox.tsx"],"names":[],"mappings":"AAIA,UAAU,kBAAkB;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,QAAA,MAAM,QAAQ,GAAI,wBAAgC,kBAAkB,gCAYnE,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Checkbox.test.d.ts","sourceRoot":"","sources":["../../../src/components/Checkbox.test.tsx"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WidthModeToggle.d.ts","sourceRoot":"","sources":["../../../src/components/WidthModeToggle.tsx"],"names":[],"mappings":"AAIA,QAAA,MAAM,eAAe,0CAgBpB,CAAC;AAEF,eAAe,eAAe,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ReactNode } from 'react';
|
|
2
|
+
interface WidthModeContextValue {
|
|
3
|
+
increasedWidthMode: boolean;
|
|
4
|
+
setIncreasedWidthMode: (value: boolean) => void;
|
|
5
|
+
}
|
|
6
|
+
interface WidthModeProviderProperties {
|
|
7
|
+
children: ReactNode;
|
|
8
|
+
}
|
|
9
|
+
export declare const WidthModeProvider: ({ children }: WidthModeProviderProperties) => import("react").JSX.Element;
|
|
10
|
+
export declare const useWidthMode: () => WidthModeContextValue | null;
|
|
11
|
+
export {};
|
|
12
|
+
//# sourceMappingURL=WidthModeContext.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WidthModeContext.d.ts","sourceRoot":"","sources":["../../../src/context/WidthModeContext.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIvC,UAAU,qBAAqB;IAC9B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CAChD;AAID,UAAU,2BAA2B;IACpC,QAAQ,EAAE,SAAS,CAAC;CACpB;AAED,eAAO,MAAM,iBAAiB,GAAI,cAAc,2BAA2B,gCAkB1E,CAAC;AAEF,eAAO,MAAM,YAAY,oCAAqC,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -7,5 +7,6 @@ export { default as Mermaid } from './components/Mermaid';
|
|
|
7
7
|
export { default as BlogLink } from './components/BlogLink';
|
|
8
8
|
export { default as Table } from './components/Table';
|
|
9
9
|
export { default as CheckList, type CheckListItem } from './components/CheckList';
|
|
10
|
+
export { default as Checkbox } from './components/Checkbox';
|
|
10
11
|
export { generateIdForBlogTitle, generateUrlForBlogTitle } from './utils';
|
|
11
12
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CheckListStatic.d.ts","sourceRoot":"","sources":["../../../src/staticComponents/CheckListStatic.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"CheckListStatic.d.ts","sourceRoot":"","sources":["../../../src/staticComponents/CheckListStatic.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAK1D,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAAC,EAAE,GAAG,CAAC,CAAC;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,UAAU,mBAAmB;IAC5B,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,QAAA,MAAM,eAAe,GAAI,wCAItB,mBAAmB,gCAerB,CAAC;AAEF,eAAe,eAAe,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CheckListStatic.test.d.ts","sourceRoot":"","sources":["../../../src/staticComponents/CheckListStatic.test.tsx"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@san-siva/blogkit",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.45",
|
|
4
4
|
"description": "A reusable blog component library for React/Next.js applications with code highlighting, diagrams, and rich content features",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
import { Suspense } from 'react';
|
|
3
|
+
import { renderToStaticMarkup } from 'react-dom/server';
|
|
4
|
+
|
|
5
|
+
import Blog from './Blog';
|
|
6
|
+
import BlogStatic from '../staticComponents/BlogStatic';
|
|
7
|
+
|
|
8
|
+
describe('Blog', () => {
|
|
9
|
+
it('renders BlogStatic directly when isTocEnabled is false, skipping Suspense/BlogDynamic', () => {
|
|
10
|
+
const element = Blog({ children: 'hello', isTocEnabled: false } as never);
|
|
11
|
+
expect(element.type).toBe(BlogStatic);
|
|
12
|
+
expect(element.props.children).toBe('hello');
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
it('wraps BlogDynamic in a Suspense boundary with a BlogStatic fallback when isTocEnabled is true (default)', () => {
|
|
16
|
+
const element = Blog({ children: 'hello' } as never);
|
|
17
|
+
expect(element.type).toBe(Suspense);
|
|
18
|
+
expect(element.props.fallback.type).toBe(BlogStatic);
|
|
19
|
+
expect(element.props.children.type.$$typeof).toBe(Symbol.for('react.lazy'));
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it('renders children through the static path', () => {
|
|
23
|
+
const html = renderToStaticMarkup(<Blog isTocEnabled={false}>content</Blog>);
|
|
24
|
+
expect(html).toContain('content');
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('passes increasedWidthMode through to BlogStatic when isTocEnabled is false', () => {
|
|
28
|
+
const withIncreasedWidth = Blog({ children: 'hi', isTocEnabled: false, increasedWidthMode: true } as never);
|
|
29
|
+
expect(withIncreasedWidth.props.increasedWidthMode).toBe(true);
|
|
30
|
+
|
|
31
|
+
const withoutIncreasedWidth = Blog({ children: 'hi', isTocEnabled: false } as never);
|
|
32
|
+
expect(withoutIncreasedWidth.props.increasedWidthMode).toBe(false);
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
it('passes jsonLd through to BlogStatic when isTocEnabled is false', () => {
|
|
36
|
+
const jsonLd = { '@context': 'https://schema.org', '@type': 'Thing' } as never;
|
|
37
|
+
const element = Blog({ children: 'hi', isTocEnabled: false, jsonLd } as never);
|
|
38
|
+
expect(element.props.jsonLd).toBe(jsonLd);
|
|
39
|
+
});
|
|
40
|
+
});
|
package/src/components/Blog.tsx
CHANGED
|
@@ -12,9 +12,24 @@ interface BlogProperties {
|
|
|
12
12
|
title?: string;
|
|
13
13
|
jsonLd?: WithContext<Thing>;
|
|
14
14
|
increasedWidthMode?: boolean;
|
|
15
|
+
isTocEnabled?: boolean;
|
|
15
16
|
}
|
|
16
17
|
|
|
17
|
-
const Blog = ({
|
|
18
|
+
const Blog = ({
|
|
19
|
+
children,
|
|
20
|
+
title = 'In this article',
|
|
21
|
+
jsonLd,
|
|
22
|
+
increasedWidthMode = false,
|
|
23
|
+
isTocEnabled = true,
|
|
24
|
+
}: BlogProperties) => {
|
|
25
|
+
if (!isTocEnabled) {
|
|
26
|
+
return (
|
|
27
|
+
<BlogStatic jsonLd={jsonLd} increasedWidthMode={increasedWidthMode}>
|
|
28
|
+
{children}
|
|
29
|
+
</BlogStatic>
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
|
|
18
33
|
return (
|
|
19
34
|
<Suspense fallback={<BlogStatic jsonLd={jsonLd} increasedWidthMode={increasedWidthMode}>{children}</BlogStatic>}>
|
|
20
35
|
<BlogDynamic title={title} jsonLd={jsonLd} increasedWidthMode={increasedWidthMode}>{children}</BlogDynamic>
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { renderToStaticMarkup } from 'react-dom/server';
|
|
3
|
+
|
|
4
|
+
import Checkbox from './Checkbox';
|
|
5
|
+
|
|
6
|
+
describe('Checkbox', () => {
|
|
7
|
+
it('renders unchecked by default with no interactive attributes', () => {
|
|
8
|
+
const html = renderToStaticMarkup(<Checkbox />);
|
|
9
|
+
expect(html).not.toContain('role="checkbox"');
|
|
10
|
+
expect(html).not.toContain('tabindex');
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
it('adds role, aria-checked and tabIndex when onClick is provided', () => {
|
|
14
|
+
const html = renderToStaticMarkup(<Checkbox isChecked onClick={() => {}} />);
|
|
15
|
+
expect(html).toContain('role="checkbox"');
|
|
16
|
+
expect(html).toContain('aria-checked="true"');
|
|
17
|
+
expect(html).toContain('tabindex="0"');
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it('renders a different className when checked vs unchecked', () => {
|
|
21
|
+
const uncheckedHtml = renderToStaticMarkup(<Checkbox isChecked={false} />);
|
|
22
|
+
const checkedHtml = renderToStaticMarkup(<Checkbox isChecked />);
|
|
23
|
+
expect(checkedHtml).not.toBe(uncheckedHtml);
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('wires the onClick prop through to the rendered element', () => {
|
|
27
|
+
const onClick = vi.fn();
|
|
28
|
+
const element = Checkbox({ onClick });
|
|
29
|
+
element.props.onClick();
|
|
30
|
+
expect(onClick).toHaveBeenCalledTimes(1);
|
|
31
|
+
});
|
|
32
|
+
});
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
|
|
3
|
+
import styles from '../styles/CheckList.module.scss';
|
|
4
|
+
|
|
5
|
+
interface CheckboxProperties {
|
|
6
|
+
isChecked?: boolean;
|
|
7
|
+
onClick?: () => void;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
const Checkbox = ({ isChecked = false, onClick }: CheckboxProperties) => {
|
|
11
|
+
return (
|
|
12
|
+
<div
|
|
13
|
+
className={`${styles['check-list__item__input']} ${
|
|
14
|
+
isChecked ? styles['check-list__item__input--checked'] : ''
|
|
15
|
+
}`}
|
|
16
|
+
onClick={onClick}
|
|
17
|
+
role={onClick ? 'checkbox' : undefined}
|
|
18
|
+
aria-checked={onClick ? isChecked : undefined}
|
|
19
|
+
tabIndex={onClick ? 0 : undefined}
|
|
20
|
+
/>
|
|
21
|
+
);
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
export default Checkbox;
|
package/src/index.ts
CHANGED
|
@@ -8,6 +8,7 @@ export { default as Mermaid } from './components/Mermaid';
|
|
|
8
8
|
export { default as BlogLink } from './components/BlogLink';
|
|
9
9
|
export { default as Table } from './components/Table';
|
|
10
10
|
export { default as CheckList, type CheckListItem } from './components/CheckList';
|
|
11
|
+
export { default as Checkbox } from './components/Checkbox';
|
|
11
12
|
|
|
12
13
|
// Utilities
|
|
13
14
|
export { generateIdForBlogTitle, generateUrlForBlogTitle } from './utils';
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { renderToStaticMarkup } from 'react-dom/server';
|
|
3
|
+
|
|
4
|
+
import CheckListStatic from './CheckListStatic';
|
|
5
|
+
|
|
6
|
+
describe('CheckListStatic', () => {
|
|
7
|
+
it('renders one item per entry', () => {
|
|
8
|
+
const html = renderToStaticMarkup(
|
|
9
|
+
<CheckListStatic
|
|
10
|
+
items={[
|
|
11
|
+
{ id: 'a', children: <p>A</p> },
|
|
12
|
+
{ id: 'b', children: <p>B</p> },
|
|
13
|
+
]}
|
|
14
|
+
/>
|
|
15
|
+
);
|
|
16
|
+
expect(html).toContain('data-id="a"');
|
|
17
|
+
expect(html).toContain('data-id="b"');
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it("wires each item's onClick through to its Checkbox", () => {
|
|
21
|
+
const onClick = vi.fn();
|
|
22
|
+
const element = CheckListStatic({
|
|
23
|
+
items: [{ id: 'a', children: <p>A</p>, onClick }],
|
|
24
|
+
});
|
|
25
|
+
const checkbox = element.props.children[0].props.children[0];
|
|
26
|
+
checkbox.props.onClick();
|
|
27
|
+
expect(onClick).toHaveBeenCalledTimes(1);
|
|
28
|
+
});
|
|
29
|
+
});
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import type { HTMLAttributes, ReactElement } from 'react';
|
|
2
2
|
|
|
3
|
+
import Checkbox from '../components/Checkbox';
|
|
3
4
|
import styles from '../styles/CheckList.module.scss';
|
|
4
5
|
|
|
5
6
|
export interface CheckListItem {
|
|
6
7
|
id: string;
|
|
7
8
|
children: ReactElement<HTMLAttributes<HTMLParagraphElement>, 'p'>;
|
|
8
9
|
isChecked?: boolean;
|
|
10
|
+
onClick?: () => void;
|
|
9
11
|
}
|
|
10
12
|
|
|
11
13
|
interface CheckListProperties {
|
|
@@ -27,11 +29,7 @@ const CheckListStatic = ({
|
|
|
27
29
|
>
|
|
28
30
|
{items.map((item) => (
|
|
29
31
|
<div key={item.id} className={styles['check-list__item']} data-id={item.id}>
|
|
30
|
-
<
|
|
31
|
-
className={`${styles['check-list__item__input']} ${
|
|
32
|
-
item.isChecked ? styles['check-list__item__input--checked'] : ''
|
|
33
|
-
}`}
|
|
34
|
-
/>
|
|
32
|
+
<Checkbox isChecked={item.isChecked} onClick={item.onClick} />
|
|
35
33
|
{item.children}
|
|
36
34
|
</div>
|
|
37
35
|
))}
|