@mui/internal-docs-infra 0.1.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/LICENSE +21 -0
- package/README.md +17 -0
- package/esm/package.json +1 -0
- package/esm/useCopier/index.d.ts +15 -0
- package/esm/useCopier/index.d.ts.map +1 -0
- package/esm/useCopier/index.js +62 -0
- package/esm/useDemo/index.d.ts +51 -0
- package/esm/useDemo/index.d.ts.map +1 -0
- package/esm/useDemo/index.js +104 -0
- package/package.json +57 -0
- package/useCopier/index.d.ts +15 -0
- package/useCopier/index.js +70 -0
- package/useDemo/index.d.ts +51 -0
- package/useDemo/index.js +112 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 Material-UI SAS
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# @mui/internal-docs-infra
|
|
2
|
+
|
|
3
|
+
This package hosts the tools that help create the documentation.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install the package in your project directory with:
|
|
8
|
+
|
|
9
|
+
<!-- #npm-tag-reference -->
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @mui/internal-docs-infra
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Documentation
|
|
16
|
+
|
|
17
|
+
We have no documentation for these components.
|
package/esm/package.json
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"type":"module"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
type OnCopied = () => void;
|
|
3
|
+
type OnCopyError = (error: unknown) => void;
|
|
4
|
+
type OnCopyClick = (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
5
|
+
export type UseCopierOpts = {
|
|
6
|
+
onCopied?: OnCopied;
|
|
7
|
+
onError?: OnCopyError;
|
|
8
|
+
onClick?: OnCopyClick;
|
|
9
|
+
timeout?: number;
|
|
10
|
+
};
|
|
11
|
+
export declare function useCopier(contents: (() => string | undefined) | string, opts?: UseCopierOpts): {
|
|
12
|
+
copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
|
|
13
|
+
disabled: boolean;
|
|
14
|
+
};
|
|
15
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/useCopier/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAC;AAC3B,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;AAC5C,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;AACxE,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;kBAO3E,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC;;EA0BpD"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import _regeneratorRuntime from "@babel/runtime/helpers/esm/regeneratorRuntime";
|
|
2
|
+
import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
|
|
3
|
+
import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
|
|
4
|
+
import * as React from 'react';
|
|
5
|
+
import copyToClipboard from 'clipboard-copy';
|
|
6
|
+
export function useCopier(contents, opts) {
|
|
7
|
+
var _ref = opts || {},
|
|
8
|
+
onCopied = _ref.onCopied,
|
|
9
|
+
onError = _ref.onError,
|
|
10
|
+
onClick = _ref.onClick,
|
|
11
|
+
_ref$timeout = _ref.timeout,
|
|
12
|
+
timeout = _ref$timeout === void 0 ? 2000 : _ref$timeout;
|
|
13
|
+
var copyTimeoutRef = React.useRef(undefined);
|
|
14
|
+
var _React$useState = React.useState(false),
|
|
15
|
+
_React$useState2 = _slicedToArray(_React$useState, 2),
|
|
16
|
+
disabled = _React$useState2[0],
|
|
17
|
+
setDisabled = _React$useState2[1];
|
|
18
|
+
var copy = React.useCallback(/*#__PURE__*/function () {
|
|
19
|
+
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(event) {
|
|
20
|
+
var content;
|
|
21
|
+
return _regeneratorRuntime().wrap(function _callee$(_context) {
|
|
22
|
+
while (1) switch (_context.prev = _context.next) {
|
|
23
|
+
case 0:
|
|
24
|
+
clearTimeout(copyTimeoutRef.current);
|
|
25
|
+
setDisabled(true);
|
|
26
|
+
_context.prev = 2;
|
|
27
|
+
content = typeof contents === 'function' ? contents() : contents;
|
|
28
|
+
if (!content) {
|
|
29
|
+
_context.next = 7;
|
|
30
|
+
break;
|
|
31
|
+
}
|
|
32
|
+
_context.next = 7;
|
|
33
|
+
return copyToClipboard(content);
|
|
34
|
+
case 7:
|
|
35
|
+
onCopied == null || onCopied();
|
|
36
|
+
_context.next = 13;
|
|
37
|
+
break;
|
|
38
|
+
case 10:
|
|
39
|
+
_context.prev = 10;
|
|
40
|
+
_context.t0 = _context["catch"](2);
|
|
41
|
+
onError == null || onError(_context.t0);
|
|
42
|
+
case 13:
|
|
43
|
+
onClick == null || onClick(event);
|
|
44
|
+
copyTimeoutRef.current = setTimeout(function () {
|
|
45
|
+
clearTimeout(copyTimeoutRef.current);
|
|
46
|
+
setDisabled(false);
|
|
47
|
+
}, timeout);
|
|
48
|
+
case 15:
|
|
49
|
+
case "end":
|
|
50
|
+
return _context.stop();
|
|
51
|
+
}
|
|
52
|
+
}, _callee, null, [[2, 10]]);
|
|
53
|
+
}));
|
|
54
|
+
return function (_x) {
|
|
55
|
+
return _ref2.apply(this, arguments);
|
|
56
|
+
};
|
|
57
|
+
}(), [contents, timeout, onCopied, onError, onClick]);
|
|
58
|
+
return {
|
|
59
|
+
copy: copy,
|
|
60
|
+
disabled: disabled
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { Nodes } from 'hast';
|
|
3
|
+
import { UseCopierOpts } from "../useCopier/index.js";
|
|
4
|
+
type Source = Nodes;
|
|
5
|
+
export type Variant = {
|
|
6
|
+
component: React.ReactNode;
|
|
7
|
+
fileName: string;
|
|
8
|
+
source: Source;
|
|
9
|
+
extraSource?: {
|
|
10
|
+
[key: string]: Source;
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type Demo = {
|
|
14
|
+
name?: string;
|
|
15
|
+
slug?: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
variants: {
|
|
18
|
+
[key: string]: Variant;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
type UseDemoOpts = {
|
|
22
|
+
defaultOpen?: boolean;
|
|
23
|
+
copy?: UseCopierOpts;
|
|
24
|
+
githubUrlPrefix?: string;
|
|
25
|
+
codeSandboxUrlPrefix?: string;
|
|
26
|
+
stackBlitzPrefix?: string;
|
|
27
|
+
};
|
|
28
|
+
export declare function useDemo(demo: Demo, opts?: UseDemoOpts): {
|
|
29
|
+
component: React.ReactNode;
|
|
30
|
+
name: string | undefined;
|
|
31
|
+
slug: string | undefined;
|
|
32
|
+
description: string | undefined;
|
|
33
|
+
ref: React.RefObject<HTMLDivElement | null>;
|
|
34
|
+
variants: string[];
|
|
35
|
+
selectedVariant: string;
|
|
36
|
+
selectVariant: React.Dispatch<React.SetStateAction<string>>;
|
|
37
|
+
files: {
|
|
38
|
+
name: string;
|
|
39
|
+
component: JSX.Element;
|
|
40
|
+
}[];
|
|
41
|
+
selectedFile: any;
|
|
42
|
+
selectedFileName: string;
|
|
43
|
+
selectFileName: React.Dispatch<React.SetStateAction<string>>;
|
|
44
|
+
expanded: boolean;
|
|
45
|
+
expand: () => void;
|
|
46
|
+
setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
|
|
47
|
+
resetFocus: () => void;
|
|
48
|
+
copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
|
|
49
|
+
copyDisabled: boolean;
|
|
50
|
+
};
|
|
51
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/useDemo/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAK7B,OAAO,EAAa,aAAa,EAAE,MAAM,cAAc,CAAC;AAExD,KAAK,MAAM,GAAG,KAAK,CAAC;AACpB,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAMF,wBAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;EA0ErD"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
|
|
2
|
+
import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
|
|
3
|
+
import * as React from 'react';
|
|
4
|
+
import { Fragment, jsx, jsxs } from 'react/jsx-runtime';
|
|
5
|
+
import { toText } from 'hast-util-to-text';
|
|
6
|
+
import { toJsxRuntime } from 'hast-util-to-jsx-runtime';
|
|
7
|
+
import kebabCase from 'kebab-case';
|
|
8
|
+
import { useCopier } from "../useCopier/index.js";
|
|
9
|
+
function toComponent(source) {
|
|
10
|
+
return toJsxRuntime(source, {
|
|
11
|
+
Fragment: Fragment,
|
|
12
|
+
jsx: jsx,
|
|
13
|
+
jsxs: jsxs
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
export function useDemo(demo, opts) {
|
|
17
|
+
var _ref = opts || {},
|
|
18
|
+
copyOpts = _ref.copy,
|
|
19
|
+
_ref$defaultOpen = _ref.defaultOpen,
|
|
20
|
+
defaultOpen = _ref$defaultOpen === void 0 ? false : _ref$defaultOpen;
|
|
21
|
+
var slug = React.useMemo(function () {
|
|
22
|
+
return demo.slug || (demo.name ? kebabCase(demo.name, false) : undefined);
|
|
23
|
+
}, [demo.slug, demo.name]);
|
|
24
|
+
var _React$useState = React.useState(defaultOpen),
|
|
25
|
+
_React$useState2 = _slicedToArray(_React$useState, 2),
|
|
26
|
+
expanded = _React$useState2[0],
|
|
27
|
+
setExpanded = _React$useState2[1];
|
|
28
|
+
var expand = React.useCallback(function () {
|
|
29
|
+
return setExpanded(true);
|
|
30
|
+
}, []);
|
|
31
|
+
var ref = React.useRef(null);
|
|
32
|
+
var resetFocus = React.useCallback(function () {
|
|
33
|
+
var _ref$current;
|
|
34
|
+
(_ref$current = ref.current) == null || _ref$current.focus();
|
|
35
|
+
}, []);
|
|
36
|
+
var variantKeys = React.useMemo(function () {
|
|
37
|
+
return Object.keys(demo.variants);
|
|
38
|
+
}, [demo.variants]);
|
|
39
|
+
var _React$useState3 = React.useState(variantKeys[0]),
|
|
40
|
+
_React$useState4 = _slicedToArray(_React$useState3, 2),
|
|
41
|
+
selectedVariantKey = _React$useState4[0],
|
|
42
|
+
setSelectedVariantKey = _React$useState4[1];
|
|
43
|
+
var selectedVariant = demo.variants[selectedVariantKey];
|
|
44
|
+
var _React$useState5 = React.useState(selectedVariant.fileName),
|
|
45
|
+
_React$useState6 = _slicedToArray(_React$useState5, 2),
|
|
46
|
+
selectedFileName = _React$useState6[0],
|
|
47
|
+
setSelectedFileName = _React$useState6[1];
|
|
48
|
+
var selectedFile = React.useMemo(function () {
|
|
49
|
+
var _selectedVariant$extr;
|
|
50
|
+
return selectedFileName === selectedVariant.fileName ? selectedVariant.source : (_selectedVariant$extr = selectedVariant.extraSource) == null ? void 0 : _selectedVariant$extr[selectedFileName];
|
|
51
|
+
}, [selectedFileName, selectedVariant]);
|
|
52
|
+
|
|
53
|
+
// if copying, convert the selected file's hast to text
|
|
54
|
+
var sourceFileToText = React.useCallback(function () {
|
|
55
|
+
return selectedFile && toText(selectedFile, {
|
|
56
|
+
whitespace: 'pre'
|
|
57
|
+
});
|
|
58
|
+
},
|
|
59
|
+
// TODO: allow passing the filename to copy
|
|
60
|
+
[selectedFile]);
|
|
61
|
+
var _useCopier = useCopier(sourceFileToText, copyOpts),
|
|
62
|
+
copy = _useCopier.copy,
|
|
63
|
+
copyDisabled = _useCopier.disabled;
|
|
64
|
+
|
|
65
|
+
// transform hast source to React components
|
|
66
|
+
var files = React.useMemo(function () {
|
|
67
|
+
var extraSource = selectedVariant.extraSource;
|
|
68
|
+
return [{
|
|
69
|
+
name: selectedVariant.fileName,
|
|
70
|
+
component: toComponent(selectedVariant.source)
|
|
71
|
+
}].concat(_toConsumableArray(extraSource ? Object.keys(extraSource).map(function (name) {
|
|
72
|
+
return {
|
|
73
|
+
name: name,
|
|
74
|
+
component: toComponent(extraSource[name])
|
|
75
|
+
};
|
|
76
|
+
}) : []));
|
|
77
|
+
}, [selectedVariant]);
|
|
78
|
+
var selectedFileComponent = React.useMemo(function () {
|
|
79
|
+
var matchedFile = files.find(function (file) {
|
|
80
|
+
return file.name === selectedFileName;
|
|
81
|
+
});
|
|
82
|
+
return matchedFile ? matchedFile.component : null;
|
|
83
|
+
}, [files, selectedFileName]);
|
|
84
|
+
return {
|
|
85
|
+
component: selectedVariant.component,
|
|
86
|
+
name: demo.name,
|
|
87
|
+
slug: slug,
|
|
88
|
+
description: demo.description,
|
|
89
|
+
ref: ref,
|
|
90
|
+
variants: variantKeys,
|
|
91
|
+
selectedVariant: selectedVariantKey,
|
|
92
|
+
selectVariant: setSelectedVariantKey,
|
|
93
|
+
files: files,
|
|
94
|
+
selectedFile: selectedFileComponent,
|
|
95
|
+
selectedFileName: selectedFileName,
|
|
96
|
+
selectFileName: setSelectedFileName,
|
|
97
|
+
expanded: expanded,
|
|
98
|
+
expand: expand,
|
|
99
|
+
setExpanded: setExpanded,
|
|
100
|
+
resetFocus: resetFocus,
|
|
101
|
+
copy: copy,
|
|
102
|
+
copyDisabled: copyDisabled
|
|
103
|
+
};
|
|
104
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@mui/internal-docs-infra",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"author": "MUI Team",
|
|
5
|
+
"description": "MUI Infra - internal documentation creation tools.",
|
|
6
|
+
"main": "./index.js",
|
|
7
|
+
"exports": {
|
|
8
|
+
"./package.json": "./package.json",
|
|
9
|
+
".": "./index.js",
|
|
10
|
+
"./*": "./*/index.js"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [
|
|
13
|
+
"react",
|
|
14
|
+
"react-component",
|
|
15
|
+
"material-ui",
|
|
16
|
+
"material design",
|
|
17
|
+
"docs"
|
|
18
|
+
],
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/mui/mui-public.git",
|
|
22
|
+
"directory": "packages/mui-docs"
|
|
23
|
+
},
|
|
24
|
+
"license": "MIT",
|
|
25
|
+
"bugs": {
|
|
26
|
+
"url": "https://github.com/mui/mui-public/issues"
|
|
27
|
+
},
|
|
28
|
+
"homepage": "https://github.com/mui/mui-public/tree/master/packages/docs-infra",
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@babel/runtime": "^7.27.6",
|
|
31
|
+
"@types/hast": "^3.0.4",
|
|
32
|
+
"clipboard-copy": "^4.0.1",
|
|
33
|
+
"hast": "^1.0.0",
|
|
34
|
+
"hast-util-to-jsx-runtime": "^2.3.6",
|
|
35
|
+
"hast-util-to-text": "^4.0.2",
|
|
36
|
+
"kebab-case": "^2.0.2"
|
|
37
|
+
},
|
|
38
|
+
"peerDependencies": {
|
|
39
|
+
"@types/react": "^17.0.0 || ^18.0.0 || ^19.0.0",
|
|
40
|
+
"next": "^13.5.1 || ^14 || ^15.0.0",
|
|
41
|
+
"react": "^17.0.0 || ^18.0.0 || ^19.0.0"
|
|
42
|
+
},
|
|
43
|
+
"peerDependenciesMeta": {
|
|
44
|
+
"@types/react": {
|
|
45
|
+
"optional": true
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"publishConfig": {
|
|
49
|
+
"access": "public",
|
|
50
|
+
"directory": "build"
|
|
51
|
+
},
|
|
52
|
+
"engines": {
|
|
53
|
+
"node": ">=14.0.0"
|
|
54
|
+
},
|
|
55
|
+
"private": false,
|
|
56
|
+
"module": "./esm/index.js"
|
|
57
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
type OnCopied = () => void;
|
|
3
|
+
type OnCopyError = (error: unknown) => void;
|
|
4
|
+
type OnCopyClick = (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
5
|
+
export type UseCopierOpts = {
|
|
6
|
+
onCopied?: OnCopied;
|
|
7
|
+
onError?: OnCopyError;
|
|
8
|
+
onClick?: OnCopyClick;
|
|
9
|
+
timeout?: number;
|
|
10
|
+
};
|
|
11
|
+
export declare function useCopier(contents: (() => string | undefined) | string, opts?: UseCopierOpts): {
|
|
12
|
+
copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
|
|
13
|
+
disabled: boolean;
|
|
14
|
+
};
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard")["default"];
|
|
4
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
|
|
5
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.useCopier = useCopier;
|
|
9
|
+
var _regeneratorRuntime2 = _interopRequireDefault(require("@babel/runtime/helpers/regeneratorRuntime"));
|
|
10
|
+
var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
|
|
11
|
+
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
|
|
12
|
+
var React = _interopRequireWildcard(require("react"));
|
|
13
|
+
var _clipboardCopy = _interopRequireDefault(require("clipboard-copy"));
|
|
14
|
+
function useCopier(contents, opts) {
|
|
15
|
+
var _ref = opts || {},
|
|
16
|
+
onCopied = _ref.onCopied,
|
|
17
|
+
onError = _ref.onError,
|
|
18
|
+
onClick = _ref.onClick,
|
|
19
|
+
_ref$timeout = _ref.timeout,
|
|
20
|
+
timeout = _ref$timeout === void 0 ? 2000 : _ref$timeout;
|
|
21
|
+
var copyTimeoutRef = React.useRef(undefined);
|
|
22
|
+
var _React$useState = React.useState(false),
|
|
23
|
+
_React$useState2 = (0, _slicedToArray2["default"])(_React$useState, 2),
|
|
24
|
+
disabled = _React$useState2[0],
|
|
25
|
+
setDisabled = _React$useState2[1];
|
|
26
|
+
var copy = React.useCallback(/*#__PURE__*/function () {
|
|
27
|
+
var _ref2 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/(0, _regeneratorRuntime2["default"])().mark(function _callee(event) {
|
|
28
|
+
var content;
|
|
29
|
+
return (0, _regeneratorRuntime2["default"])().wrap(function _callee$(_context) {
|
|
30
|
+
while (1) switch (_context.prev = _context.next) {
|
|
31
|
+
case 0:
|
|
32
|
+
clearTimeout(copyTimeoutRef.current);
|
|
33
|
+
setDisabled(true);
|
|
34
|
+
_context.prev = 2;
|
|
35
|
+
content = typeof contents === 'function' ? contents() : contents;
|
|
36
|
+
if (!content) {
|
|
37
|
+
_context.next = 7;
|
|
38
|
+
break;
|
|
39
|
+
}
|
|
40
|
+
_context.next = 7;
|
|
41
|
+
return (0, _clipboardCopy["default"])(content);
|
|
42
|
+
case 7:
|
|
43
|
+
onCopied == null || onCopied();
|
|
44
|
+
_context.next = 13;
|
|
45
|
+
break;
|
|
46
|
+
case 10:
|
|
47
|
+
_context.prev = 10;
|
|
48
|
+
_context.t0 = _context["catch"](2);
|
|
49
|
+
onError == null || onError(_context.t0);
|
|
50
|
+
case 13:
|
|
51
|
+
onClick == null || onClick(event);
|
|
52
|
+
copyTimeoutRef.current = setTimeout(function () {
|
|
53
|
+
clearTimeout(copyTimeoutRef.current);
|
|
54
|
+
setDisabled(false);
|
|
55
|
+
}, timeout);
|
|
56
|
+
case 15:
|
|
57
|
+
case "end":
|
|
58
|
+
return _context.stop();
|
|
59
|
+
}
|
|
60
|
+
}, _callee, null, [[2, 10]]);
|
|
61
|
+
}));
|
|
62
|
+
return function (_x) {
|
|
63
|
+
return _ref2.apply(this, arguments);
|
|
64
|
+
};
|
|
65
|
+
}(), [contents, timeout, onCopied, onError, onClick]);
|
|
66
|
+
return {
|
|
67
|
+
copy: copy,
|
|
68
|
+
disabled: disabled
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { Nodes } from 'hast';
|
|
3
|
+
import { UseCopierOpts } from "../useCopier/index.js";
|
|
4
|
+
type Source = Nodes;
|
|
5
|
+
export type Variant = {
|
|
6
|
+
component: React.ReactNode;
|
|
7
|
+
fileName: string;
|
|
8
|
+
source: Source;
|
|
9
|
+
extraSource?: {
|
|
10
|
+
[key: string]: Source;
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type Demo = {
|
|
14
|
+
name?: string;
|
|
15
|
+
slug?: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
variants: {
|
|
18
|
+
[key: string]: Variant;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
type UseDemoOpts = {
|
|
22
|
+
defaultOpen?: boolean;
|
|
23
|
+
copy?: UseCopierOpts;
|
|
24
|
+
githubUrlPrefix?: string;
|
|
25
|
+
codeSandboxUrlPrefix?: string;
|
|
26
|
+
stackBlitzPrefix?: string;
|
|
27
|
+
};
|
|
28
|
+
export declare function useDemo(demo: Demo, opts?: UseDemoOpts): {
|
|
29
|
+
component: React.ReactNode;
|
|
30
|
+
name: string | undefined;
|
|
31
|
+
slug: string | undefined;
|
|
32
|
+
description: string | undefined;
|
|
33
|
+
ref: React.RefObject<HTMLDivElement | null>;
|
|
34
|
+
variants: string[];
|
|
35
|
+
selectedVariant: string;
|
|
36
|
+
selectVariant: React.Dispatch<React.SetStateAction<string>>;
|
|
37
|
+
files: {
|
|
38
|
+
name: string;
|
|
39
|
+
component: JSX.Element;
|
|
40
|
+
}[];
|
|
41
|
+
selectedFile: any;
|
|
42
|
+
selectedFileName: string;
|
|
43
|
+
selectFileName: React.Dispatch<React.SetStateAction<string>>;
|
|
44
|
+
expanded: boolean;
|
|
45
|
+
expand: () => void;
|
|
46
|
+
setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
|
|
47
|
+
resetFocus: () => void;
|
|
48
|
+
copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
|
|
49
|
+
copyDisabled: boolean;
|
|
50
|
+
};
|
|
51
|
+
export {};
|
package/useDemo/index.js
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard")["default"];
|
|
4
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
|
|
5
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.useDemo = useDemo;
|
|
9
|
+
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
|
|
10
|
+
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
|
|
11
|
+
var React = _interopRequireWildcard(require("react"));
|
|
12
|
+
var _jsxRuntime = require("react/jsx-runtime");
|
|
13
|
+
var _hastUtilToText = require("hast-util-to-text");
|
|
14
|
+
var _hastUtilToJsxRuntime = require("hast-util-to-jsx-runtime");
|
|
15
|
+
var _kebabCase = _interopRequireDefault(require("kebab-case"));
|
|
16
|
+
var _useCopier2 = require("../useCopier");
|
|
17
|
+
function toComponent(source) {
|
|
18
|
+
return (0, _hastUtilToJsxRuntime.toJsxRuntime)(source, {
|
|
19
|
+
Fragment: _jsxRuntime.Fragment,
|
|
20
|
+
jsx: _jsxRuntime.jsx,
|
|
21
|
+
jsxs: _jsxRuntime.jsxs
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
function useDemo(demo, opts) {
|
|
25
|
+
var _ref = opts || {},
|
|
26
|
+
copyOpts = _ref.copy,
|
|
27
|
+
_ref$defaultOpen = _ref.defaultOpen,
|
|
28
|
+
defaultOpen = _ref$defaultOpen === void 0 ? false : _ref$defaultOpen;
|
|
29
|
+
var slug = React.useMemo(function () {
|
|
30
|
+
return demo.slug || (demo.name ? (0, _kebabCase["default"])(demo.name, false) : undefined);
|
|
31
|
+
}, [demo.slug, demo.name]);
|
|
32
|
+
var _React$useState = React.useState(defaultOpen),
|
|
33
|
+
_React$useState2 = (0, _slicedToArray2["default"])(_React$useState, 2),
|
|
34
|
+
expanded = _React$useState2[0],
|
|
35
|
+
setExpanded = _React$useState2[1];
|
|
36
|
+
var expand = React.useCallback(function () {
|
|
37
|
+
return setExpanded(true);
|
|
38
|
+
}, []);
|
|
39
|
+
var ref = React.useRef(null);
|
|
40
|
+
var resetFocus = React.useCallback(function () {
|
|
41
|
+
var _ref$current;
|
|
42
|
+
(_ref$current = ref.current) == null || _ref$current.focus();
|
|
43
|
+
}, []);
|
|
44
|
+
var variantKeys = React.useMemo(function () {
|
|
45
|
+
return Object.keys(demo.variants);
|
|
46
|
+
}, [demo.variants]);
|
|
47
|
+
var _React$useState3 = React.useState(variantKeys[0]),
|
|
48
|
+
_React$useState4 = (0, _slicedToArray2["default"])(_React$useState3, 2),
|
|
49
|
+
selectedVariantKey = _React$useState4[0],
|
|
50
|
+
setSelectedVariantKey = _React$useState4[1];
|
|
51
|
+
var selectedVariant = demo.variants[selectedVariantKey];
|
|
52
|
+
var _React$useState5 = React.useState(selectedVariant.fileName),
|
|
53
|
+
_React$useState6 = (0, _slicedToArray2["default"])(_React$useState5, 2),
|
|
54
|
+
selectedFileName = _React$useState6[0],
|
|
55
|
+
setSelectedFileName = _React$useState6[1];
|
|
56
|
+
var selectedFile = React.useMemo(function () {
|
|
57
|
+
var _selectedVariant$extr;
|
|
58
|
+
return selectedFileName === selectedVariant.fileName ? selectedVariant.source : (_selectedVariant$extr = selectedVariant.extraSource) == null ? void 0 : _selectedVariant$extr[selectedFileName];
|
|
59
|
+
}, [selectedFileName, selectedVariant]);
|
|
60
|
+
|
|
61
|
+
// if copying, convert the selected file's hast to text
|
|
62
|
+
var sourceFileToText = React.useCallback(function () {
|
|
63
|
+
return selectedFile && (0, _hastUtilToText.toText)(selectedFile, {
|
|
64
|
+
whitespace: 'pre'
|
|
65
|
+
});
|
|
66
|
+
},
|
|
67
|
+
// TODO: allow passing the filename to copy
|
|
68
|
+
[selectedFile]);
|
|
69
|
+
var _useCopier = (0, _useCopier2.useCopier)(sourceFileToText, copyOpts),
|
|
70
|
+
copy = _useCopier.copy,
|
|
71
|
+
copyDisabled = _useCopier.disabled;
|
|
72
|
+
|
|
73
|
+
// transform hast source to React components
|
|
74
|
+
var files = React.useMemo(function () {
|
|
75
|
+
var extraSource = selectedVariant.extraSource;
|
|
76
|
+
return [{
|
|
77
|
+
name: selectedVariant.fileName,
|
|
78
|
+
component: toComponent(selectedVariant.source)
|
|
79
|
+
}].concat((0, _toConsumableArray2["default"])(extraSource ? Object.keys(extraSource).map(function (name) {
|
|
80
|
+
return {
|
|
81
|
+
name: name,
|
|
82
|
+
component: toComponent(extraSource[name])
|
|
83
|
+
};
|
|
84
|
+
}) : []));
|
|
85
|
+
}, [selectedVariant]);
|
|
86
|
+
var selectedFileComponent = React.useMemo(function () {
|
|
87
|
+
var matchedFile = files.find(function (file) {
|
|
88
|
+
return file.name === selectedFileName;
|
|
89
|
+
});
|
|
90
|
+
return matchedFile ? matchedFile.component : null;
|
|
91
|
+
}, [files, selectedFileName]);
|
|
92
|
+
return {
|
|
93
|
+
component: selectedVariant.component,
|
|
94
|
+
name: demo.name,
|
|
95
|
+
slug: slug,
|
|
96
|
+
description: demo.description,
|
|
97
|
+
ref: ref,
|
|
98
|
+
variants: variantKeys,
|
|
99
|
+
selectedVariant: selectedVariantKey,
|
|
100
|
+
selectVariant: setSelectedVariantKey,
|
|
101
|
+
files: files,
|
|
102
|
+
selectedFile: selectedFileComponent,
|
|
103
|
+
selectedFileName: selectedFileName,
|
|
104
|
+
selectFileName: setSelectedFileName,
|
|
105
|
+
expanded: expanded,
|
|
106
|
+
expand: expand,
|
|
107
|
+
setExpanded: setExpanded,
|
|
108
|
+
resetFocus: resetFocus,
|
|
109
|
+
copy: copy,
|
|
110
|
+
copyDisabled: copyDisabled
|
|
111
|
+
};
|
|
112
|
+
}
|