@petercoxhatesbridges/extension-ui 0.1.0 → 0.1.1
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/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# `@petercoxhatesbridges/extension-ui`
|
|
2
2
|
|
|
3
|
-
Reusable React UI components for browser extensions. Version `0.1.
|
|
3
|
+
Reusable React UI components for browser extensions. Version `0.1.1`.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -56,12 +56,16 @@ TLDA can use these exports from its Storybook setup.
|
|
|
56
56
|
## Configured shell
|
|
57
57
|
|
|
58
58
|
`ExtensionShell` combines the lower-level layout components. Supply `branding`
|
|
59
|
-
(`name`, optional `accessibleName`, `subtitle`, and `logo` React node),
|
|
60
|
-
`version`, `beta` or `buildLabel`, `tabs`, controlled `activeTab`/`onTabChange`,
|
|
59
|
+
(`name`, optional `accessibleName`, `subtitle`, and `logo` React node), required
|
|
60
|
+
`version` and `footerLinks`, optional `beta` or `buildLabel`, `tabs`, controlled `activeTab`/`onTabChange`,
|
|
61
61
|
and page content as children (normally `TabsContent`). Tab entries contain `id`,
|
|
62
62
|
`label`, optional `navigationLabel`, `icon`, `description`, `secondary`, and
|
|
63
63
|
`disabled`. Put secondary navigation such as Settings last; it follows the flexible spacer.
|
|
64
64
|
|
|
65
|
+
The version and footer remain visible while the content scrolls. Localhost
|
|
66
|
+
(including loopback addresses) automatically displays Beta; consumers pass `beta`
|
|
67
|
+
for unpacked development builds that use extension URLs.
|
|
68
|
+
|
|
65
69
|
`footerLinks` accepts `href`, `label`, and optional `icon`. Optional `header`,
|
|
66
70
|
`navigation`, `heading`, and `footer` slots replace those regions. `loading` and
|
|
67
71
|
`loadingText` control the loading message; `status` supplies polite live feedback.
|
package/dist/ExtensionShell.d.ts
CHANGED
|
@@ -21,13 +21,13 @@ export type ExtensionShellProps = Omit<ComponentProps<typeof PreferencesShell>,
|
|
|
21
21
|
subtitle?: string;
|
|
22
22
|
logo?: ReactNode;
|
|
23
23
|
};
|
|
24
|
-
version
|
|
24
|
+
version: string;
|
|
25
25
|
beta?: boolean;
|
|
26
26
|
buildLabel?: string;
|
|
27
27
|
tabs: readonly ExtensionNavigationItem[];
|
|
28
28
|
activeTab: string;
|
|
29
29
|
onTabChange: (value: string) => void;
|
|
30
|
-
footerLinks
|
|
30
|
+
footerLinks: readonly ExtensionFooterLink[];
|
|
31
31
|
loading?: boolean;
|
|
32
32
|
loadingText?: string;
|
|
33
33
|
status?: ReactNode;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExtensionShell.d.ts","sourceRoot":"","sources":["../src/ExtensionShell.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EACL,gBAAgB,EAMjB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,cAAc,CAAC,OAAO,gBAAgB,CAAC,EACvC,OAAO,GAAG,eAAe,GAAG,cAAc,CAC3C,GAAG;IACF,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAC;IACF,OAAO,
|
|
1
|
+
{"version":3,"file":"ExtensionShell.d.ts","sourceRoot":"","sources":["../src/ExtensionShell.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EACL,gBAAgB,EAMjB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,cAAc,CAAC,OAAO,gBAAgB,CAAC,EACvC,OAAO,GAAG,eAAe,GAAG,cAAc,CAC3C,GAAG;IACF,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,SAAS,uBAAuB,EAAE,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,WAAW,EAAE,SAAS,mBAAmB,EAAE,CAAC;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,CAAC;AACF,wBAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,OAAO,EACP,IAAY,EACZ,UAAU,EACV,IAAI,EACJ,SAAS,EACT,WAAW,EACX,WAAW,EACX,OAAe,EACf,WAAoC,EACpC,MAAM,EACN,MAAM,EACN,UAAU,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,GAAG,KAAK,EACT,EAAE,mBAAmB,+BAkGrB"}
|
package/dist/ExtensionShell.js
CHANGED
|
@@ -4,10 +4,14 @@ import { PreferencesShell, PreferencesHeader, PreferencesLayout, PreferencesNavi
|
|
|
4
4
|
import { TabsList, TabsTrigger } from "./Tabs.js";
|
|
5
5
|
import { InfoBanner } from "./InfoBanner.js";
|
|
6
6
|
import { SaveStatus } from "./SettingsSection.js";
|
|
7
|
-
export function ExtensionShell({ branding, version, beta = false, buildLabel, tabs, activeTab, onTabChange, footerLinks
|
|
7
|
+
export function ExtensionShell({ branding, version, beta = false, buildLabel, tabs, activeTab, onTabChange, footerLinks, loading = false, loadingText = "Loading preferences…", status, header, navigation, heading, footer, children, ...props }) {
|
|
8
8
|
const currentTab = tabs.find((tab) => tab.id === activeTab);
|
|
9
|
-
const
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
const localPreview = typeof location !== "undefined" &&
|
|
10
|
+
["localhost", "127.0.0.1", "[::1]", "::1"].includes(location.hostname);
|
|
11
|
+
const badge = localPreview
|
|
12
|
+
? "Beta"
|
|
13
|
+
: (buildLabel ?? (beta ? "Beta" : undefined));
|
|
14
|
+
return (_jsxs(PreferencesShell, { ...props, value: activeTab, onValueChange: onTabChange, children: [_jsxs(PreferencesHeader, { children: [header ?? (_jsxs(_Fragment, { children: [branding.logo, _jsxs("div", { className: "brand-wordmark", "aria-label": branding.accessibleName ?? branding.name, children: [_jsx("strong", { children: branding.name }), branding.subtitle && _jsx("span", { children: branding.subtitle })] })] })), _jsxs("span", { className: "extension-version", children: ["v", version] }), badge && (_jsx("span", { className: "extension-build-badge", "aria-label": `${badge} build`, children: badge }))] }), _jsxs(PreferencesLayout, { children: [_jsx(PreferencesNavigation, { children: navigation ?? (_jsx(TabsList, { className: "preferences-tabs-list", "aria-label": "Preference sections", children: tabs.map((tab, index) => (_jsxs(Fragment, { children: [tab.secondary && !tabs[index - 1]?.secondary && (_jsx("div", { className: "preferences-tabs-spacer", "aria-hidden": "true" })), _jsxs(TabsTrigger, { className: "preferences-tab", value: tab.id, disabled: tab.disabled, "aria-label": tab.label, title: tab.label, "data-tooltip": tab.label, children: [tab.icon, _jsx("span", { children: tab.navigationLabel ?? tab.label })] })] }, tab.id))) })) }), _jsxs(PreferencesContent, { children: [heading ?? (_jsxs(_Fragment, { children: [_jsx("div", { className: "preferences-content-heading", children: _jsx("h1", { children: currentTab?.label }) }), currentTab?.description && (_jsx(InfoBanner, { children: currentTab.description }))] })), loading ? (_jsx("p", { className: "loading", role: "status", children: loadingText })) : (children), _jsx(SaveStatus, { children: status })] }), _jsx(PreferencesFooter, { children: footer ??
|
|
15
|
+
footerLinks.map((link) => (_jsxs("a", { href: link.href, target: "_blank", rel: "noreferrer", children: [link.icon, link.label] }, link.href))) })] })] }));
|
|
12
16
|
}
|
|
13
17
|
//# sourceMappingURL=ExtensionShell.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExtensionShell.js","sourceRoot":"","sources":["../src/ExtensionShell.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAuC,MAAM,OAAO,CAAC;AACtE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAwClD,MAAM,UAAU,cAAc,CAAC,EAC7B,QAAQ,EACR,OAAO,EACP,IAAI,GAAG,KAAK,EACZ,UAAU,EACV,IAAI,EACJ,SAAS,EACT,WAAW,EACX,WAAW,
|
|
1
|
+
{"version":3,"file":"ExtensionShell.js","sourceRoot":"","sources":["../src/ExtensionShell.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAuC,MAAM,OAAO,CAAC;AACtE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAwClD,MAAM,UAAU,cAAc,CAAC,EAC7B,QAAQ,EACR,OAAO,EACP,IAAI,GAAG,KAAK,EACZ,UAAU,EACV,IAAI,EACJ,SAAS,EACT,WAAW,EACX,WAAW,EACX,OAAO,GAAG,KAAK,EACf,WAAW,GAAG,sBAAsB,EACpC,MAAM,EACN,MAAM,EACN,UAAU,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,GAAG,KAAK,EACY;IACpB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;IAC5D,MAAM,YAAY,GAChB,OAAO,QAAQ,KAAK,WAAW;QAC/B,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,YAAY;QACxB,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAChD,OAAO,CACL,MAAC,gBAAgB,OAAK,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,aACvE,MAAC,iBAAiB,eACf,MAAM,IAAI,CACT,8BACG,QAAQ,CAAC,IAAI,EACd,eACE,SAAS,EAAC,gBAAgB,gBACd,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,IAAI,aAEpD,2BAAS,QAAQ,CAAC,IAAI,GAAU,EAC/B,QAAQ,CAAC,QAAQ,IAAI,yBAAO,QAAQ,CAAC,QAAQ,GAAQ,IAClD,IACL,CACJ,EACD,gBAAM,SAAS,EAAC,mBAAmB,kBAAG,OAAO,IAAQ,EACpD,KAAK,IAAI,CACR,eAAM,SAAS,EAAC,uBAAuB,gBAAa,GAAG,KAAK,QAAQ,YACjE,KAAK,GACD,CACR,IACiB,EACpB,MAAC,iBAAiB,eAChB,KAAC,qBAAqB,cACnB,UAAU,IAAI,CACb,KAAC,QAAQ,IACP,SAAS,EAAC,uBAAuB,gBACtB,qBAAqB,YAE/B,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CACxB,MAAC,QAAQ,eACN,GAAG,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,SAAS,IAAI,CAC/C,cACE,SAAS,EAAC,yBAAyB,iBACvB,MAAM,GAClB,CACH,EACD,MAAC,WAAW,IACV,SAAS,EAAC,iBAAiB,EAC3B,KAAK,EAAE,GAAG,CAAC,EAAE,EACb,QAAQ,EAAE,GAAG,CAAC,QAAQ,gBACV,GAAG,CAAC,KAAK,EACrB,KAAK,EAAE,GAAG,CAAC,KAAK,kBACF,GAAG,CAAC,KAAK,aAEtB,GAAG,CAAC,IAAI,EACT,yBAAO,GAAG,CAAC,eAAe,IAAI,GAAG,CAAC,KAAK,GAAQ,IACnC,KAjBD,GAAG,CAAC,EAAE,CAkBV,CACZ,CAAC,GACO,CACZ,GACqB,EACxB,MAAC,kBAAkB,eAChB,OAAO,IAAI,CACV,8BACE,cAAK,SAAS,EAAC,6BAA6B,YAC1C,uBAAK,UAAU,EAAE,KAAK,GAAM,GACxB,EACL,UAAU,EAAE,WAAW,IAAI,CAC1B,KAAC,UAAU,cAAE,UAAU,CAAC,WAAW,GAAc,CAClD,IACA,CACJ,EACA,OAAO,CAAC,CAAC,CAAC,CACT,YAAG,SAAS,EAAC,SAAS,EAAC,IAAI,EAAC,QAAQ,YACjC,WAAW,GACV,CACL,CAAC,CAAC,CAAC,CACF,QAAQ,CACT,EACD,KAAC,UAAU,cAAE,MAAM,GAAc,IACd,EACrB,KAAC,iBAAiB,cACf,MAAM;4BACL,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACxB,aAEE,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,MAAM,EAAC,QAAQ,EACf,GAAG,EAAC,YAAY,aAEf,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,KAAK,KANN,IAAI,CAAC,IAAI,CAOZ,CACL,CAAC,GACc,IACF,IACH,CACpB,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -89,6 +89,8 @@ export const ConfiguredShell: Story = {
|
|
|
89
89
|
export const LoadingAndSaveError: Story = {
|
|
90
90
|
render: () => (
|
|
91
91
|
<ExtensionShell
|
|
92
|
+
version="1.0.0"
|
|
93
|
+
footerLinks={[{ href: "https://example.com/about", label: "About me" }]}
|
|
92
94
|
branding={{ name: "My extension" }}
|
|
93
95
|
tabs={tabs}
|
|
94
96
|
activeTab="filters"
|