@fasl-work/caos-app-shell 0.6.4 → 0.6.5
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 +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +5 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,6 +49,7 @@ const config: ShellConfig = {
|
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
- **Land on the tool:** make `/` your interactive tool; Introduction/Methodology/etc. are separate routes.
|
|
52
|
+
- **Product metadata:** `footer.attribution` accepts bilingual text or `false` when a product excludes personal attribution. `footer.license` accepts the product's bilingual license label. Omitting these keeps existing consumer defaults. A product does not inherit the shell's MIT license.
|
|
52
53
|
- **Hub case (Faena):** pass `routes: []` (or one) → the nav is hidden, header/footer identical.
|
|
53
54
|
- **Deep pages:** compose with `Tabs`, `SubTabs`, `Equation`/`InlineMath`, `Callout`, `Figure`, and
|
|
54
55
|
`CitationsProvider` + `Cite`/`Refs`/`ReferenceList`. Read the current language with `useShellLang()`.
|
package/dist/index.d.ts
CHANGED
|
@@ -59,6 +59,16 @@ interface ShellConfig {
|
|
|
59
59
|
* license (e.g. "Engine: lingbot-map (arXiv:2604.14141, Apache-2.0)") and the one-line honest
|
|
60
60
|
* disclaimer of how the app runs. Both optional, both bilingual. */
|
|
61
61
|
footer?: {
|
|
62
|
+
/** Explicit product attribution, or false when the product excludes personal attribution. */
|
|
63
|
+
attribution?: {
|
|
64
|
+
en: string;
|
|
65
|
+
es: string;
|
|
66
|
+
} | false;
|
|
67
|
+
/** The consuming product's license; the shell's MIT license is not inherited by applications. */
|
|
68
|
+
license?: {
|
|
69
|
+
en: string;
|
|
70
|
+
es: string;
|
|
71
|
+
};
|
|
62
72
|
provenance?: {
|
|
63
73
|
en: string;
|
|
64
74
|
es: string;
|
package/dist/index.js
CHANGED
|
@@ -293,8 +293,10 @@ function AppShell({ config, children }) {
|
|
|
293
293
|
c.version,
|
|
294
294
|
config.version
|
|
295
295
|
] }) }),
|
|
296
|
-
/* @__PURE__ */
|
|
297
|
-
|
|
296
|
+
config.footer?.attribution !== false && /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
297
|
+
/* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: "\xB7" }),
|
|
298
|
+
/* @__PURE__ */ jsx("span", { children: config.footer?.attribution?.[lang] ?? c.attribution })
|
|
299
|
+
] }),
|
|
298
300
|
config.footer?.provenance && /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
299
301
|
/* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: "\xB7" }),
|
|
300
302
|
/* @__PURE__ */ jsx("span", { children: config.footer.provenance[lang] })
|
|
@@ -302,7 +304,7 @@ function AppShell({ config, children }) {
|
|
|
302
304
|
/* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: "\xB7" }),
|
|
303
305
|
/* @__PURE__ */ jsx("a", { href: config.links.github, target: "_blank", rel: "noreferrer noopener", children: c.github }),
|
|
304
306
|
/* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: "\xB7" }),
|
|
305
|
-
/* @__PURE__ */ jsx("span", { className: "faint", children: c.license }),
|
|
307
|
+
/* @__PURE__ */ jsx("span", { className: "faint", children: config.footer?.license?.[lang] ?? c.license }),
|
|
306
308
|
config.footer?.disclaimer && /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
307
309
|
/* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: "\xB7" }),
|
|
308
310
|
/* @__PURE__ */ jsx("span", { className: "faint", children: config.footer.disclaimer[lang] })
|
package/package.json
CHANGED