@cratis/scene.react 4.27.0 → 4.29.0

package/dist/esm/navigation/region/navigationItemActive.js

@@ -0,0 +1,29 @@
+import { primarySlot } from '@cratis/scene.engine';
+import { defaultScreenFor } from './navigationItemDestination.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Whether a navigation item is the one the page shows.
+ *
+ * An item is active when the screen it opens is the one in the slot it renders into: the primary region for the
+ * `content` slot, the nested outlet of that name otherwise. So several items can be active at once - each is shown in
+ * its own slot - and closing a slot's screen un-highlights its item. With `matchModule` - a topbar - an item that targets
+ * a module without a feature is also active while any screen of that module is in its slot.
+ *
+ * @param item The effective item.
+ * @param placement What the host currently shows.
+ * @param screenFor Names the screen an item opens; the feature the item resolves to when absent.
+ * @param matchModule Whether a module item is active on any screen of the module; a topbar's are, a sidebar's are not.
+ */ function navigationItemActive(item, placement, screenFor = defaultScreenFor, matchModule = false) {
+    const screen = screenFor(item);
+    if (screen === undefined) return false;
+    const shown = item.slot === primarySlot ? placement.primaryScreen : placement.outlets[item.slot];
+    if (shown === undefined) return false;
+    if (shown === screen) return true;
+    const target = item.target;
+    return matchModule && target !== undefined && target.feature === undefined && shown.startsWith(`${target.module}.`);
+}
+
+export { navigationItemActive };
+//# sourceMappingURL=navigationItemActive.js.map

package/dist/esm/navigation/region/navigationItemActive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationItemActive.js","sources":["../../../../navigation/region/navigationItemActive.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { EffectiveNavItem, primarySlot } from '@cratis/scene.engine';\nimport { defaultScreenFor } from './navigationItemDestination';\nimport { SceneNavigationContextValue } from '../SceneNavigationContext';\n\n/** Where the navigation host is: the part of {@link SceneNavigationContextValue} that says what is on the page. */\nexport type NavigationPlacement = Pick<SceneNavigationContextValue, 'primaryScreen' | 'outlets'>;\n\n/**\n * Whether a navigation item is the one the page shows.\n *\n * An item is active when the screen it opens is the one in the slot it renders into: the primary region for the\n * `content` slot, the nested outlet of that name otherwise. So several items can be active at once - each is shown in\n * its own slot - and closing a slot's screen un-highlights its item. With `matchModule` - a topbar - an item that targets\n * a module without a feature is also active while any screen of that module is in its slot.\n *\n * @param item The effective item.\n * @param placement What the host currently shows.\n * @param screenFor Names the screen an item opens; the feature the item resolves to when absent.\n * @param matchModule Whether a module item is active on any screen of the module; a topbar's are, a sidebar's are not.\n */\nexport function navigationItemActive(\n    item: EffectiveNavItem,\n    placement: NavigationPlacement,\n    screenFor: (item: EffectiveNavItem) => string | undefined = defaultScreenFor,\n    matchModule = false,\n): boolean {\n    const screen = screenFor(item);\n    if (screen === undefined) return false;\n\n    const shown = item.slot === primarySlot ? placement.primaryScreen : placement.outlets[item.slot];\n    if (shown === undefined) return false;\n    if (shown === screen) return true;\n\n    const target = item.target;\n    return matchModule && target !== undefined && target.feature === undefined && shown.startsWith(`${target.module}.`);\n}\n"],"names":["navigationItemActive","item","placement","screenFor","defaultScreenFor","matchModule","screen","undefined","shown","slot","primarySlot","primaryScreen","outlets","target","feature","startsWith","module"],"mappings":";;;AAAA;AACA;AASA;;;;;;;;;;;;IAaO,SAASA,oBAAAA,CACZC,IAAsB,EACtBC,SAA8B,EAC9BC,SAAAA,GAA4DC,gBAAgB,EAC5EC,WAAAA,GAAc,KAAK,EAAA;AAEnB,IAAA,MAAMC,SAASH,SAAAA,CAAUF,IAAAA,CAAAA;IACzB,IAAIK,MAAAA,KAAWC,WAAW,OAAO,KAAA;AAEjC,IAAA,MAAMC,KAAAA,GAAQP,IAAAA,CAAKQ,IAAI,KAAKC,WAAAA,GAAcR,SAAAA,CAAUS,aAAa,GAAGT,SAAAA,CAAUU,OAAO,CAACX,IAAAA,CAAKQ,IAAI,CAAC;IAChG,IAAID,KAAAA,KAAUD,WAAW,OAAO,KAAA;IAChC,IAAIC,KAAAA,KAAUF,QAAQ,OAAO,IAAA;IAE7B,MAAMO,MAAAA,GAASZ,KAAKY,MAAM;AAC1B,IAAA,OAAOR,WAAAA,IAAeQ,MAAAA,KAAWN,SAAAA,IAAaM,MAAAA,CAAOC,OAAO,KAAKP,SAAAA,IAAaC,KAAAA,CAAMO,UAAU,CAAC,CAAA,EAAGF,MAAAA,CAAOG,MAAM,CAAC,CAAC,CAAC,CAAA;AACtH;;"}

package/dist/esm/navigation/region/navigationItemDestination.d.ts

@@ -0,0 +1,5 @@
+import { DestinationReference } from '@cratis/scene.model';
+import { EffectiveNavItem } from '@cratis/scene.engine';
+export declare function defaultScreenFor(item: EffectiveNavItem): string | undefined;
+export declare function navigationItemDestination(item: EffectiveNavItem, screenFor?: (item: EffectiveNavItem) => string | undefined): DestinationReference | undefined;
+//# sourceMappingURL=navigationItemDestination.d.ts.map

package/dist/esm/navigation/region/navigationItemDestination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationItemDestination.d.ts","sourceRoot":"","sources":["../../../../navigation/region/navigationItemDestination.ts"],"names":[],"mappings":"AAGA,OAAO,EAAmB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAe,MAAM,sBAAsB,CAAC;AAGrE,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,GAAG,MAAM,GAAG,SAAS,CAE3E;AAUD,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,GAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,MAAM,GAAG,SAA4B,GAAG,oBAAoB,GAAG,SAAS,CAShL"}

package/dist/esm/navigation/region/navigationItemDestination.js

@@ -0,0 +1,31 @@
+import { DestinationKind } from '@cratis/scene.model';
+import { primarySlot } from '@cratis/scene.engine';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The screen an item opens by default: the qualified id of the feature it resolves to. */ function defaultScreenFor(item) {
+    return item.target?.resolvedFeature;
+}
+/**
+ * Where activating a navigation item goes: its stable module/feature identity, the screen it opens, and the slot it
+ * renders into as the outlet - the primary `content` slot is the host's primary outlet.
+ *
+ * @param item The effective item.
+ * @param screenFor Names the screen an item opens; {@link defaultScreenFor} when absent.
+ * @returns The destination, or undefined when the item leads nowhere.
+ */ function navigationItemDestination(item, screenFor = defaultScreenFor) {
+    const screen = screenFor(item);
+    if (screen === undefined || item.target === undefined) return undefined;
+    const resolved = item.target.resolvedFeature;
+    const destination = {
+        kind: DestinationKind.Outlet,
+        module: item.target.module,
+        screen
+    };
+    if (resolved !== undefined && resolved.startsWith(`${item.target.module}.`)) destination.feature = resolved.substring(item.target.module.length + 1);
+    if (item.slot !== primarySlot) destination.outlet = item.slot;
+    return destination;
+}
+
+export { defaultScreenFor, navigationItemDestination };
+//# sourceMappingURL=navigationItemDestination.js.map

package/dist/esm/navigation/region/navigationItemDestination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationItemDestination.js","sources":["../../../../navigation/region/navigationItemDestination.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { DestinationKind, DestinationReference } from '@cratis/scene.model';\nimport { EffectiveNavItem, primarySlot } from '@cratis/scene.engine';\n\n/** The screen an item opens by default: the qualified id of the feature it resolves to. */\nexport function defaultScreenFor(item: EffectiveNavItem): string | undefined {\n    return item.target?.resolvedFeature;\n}\n\n/**\n * Where activating a navigation item goes: its stable module/feature identity, the screen it opens, and the slot it\n * renders into as the outlet - the primary `content` slot is the host's primary outlet.\n *\n * @param item The effective item.\n * @param screenFor Names the screen an item opens; {@link defaultScreenFor} when absent.\n * @returns The destination, or undefined when the item leads nowhere.\n */\nexport function navigationItemDestination(item: EffectiveNavItem, screenFor: (item: EffectiveNavItem) => string | undefined = defaultScreenFor): DestinationReference | undefined {\n    const screen = screenFor(item);\n    if (screen === undefined || item.target === undefined) return undefined;\n\n    const resolved = item.target.resolvedFeature;\n    const destination: DestinationReference = { kind: DestinationKind.Outlet, module: item.target.module, screen };\n    if (resolved !== undefined && resolved.startsWith(`${item.target.module}.`)) destination.feature = resolved.substring(item.target.module.length + 1);\n    if (item.slot !== primarySlot) destination.outlet = item.slot;\n    return destination;\n}\n"],"names":["defaultScreenFor","item","target","resolvedFeature","navigationItemDestination","screenFor","screen","undefined","resolved","destination","kind","DestinationKind","Outlet","module","startsWith","feature","substring","length","slot","primarySlot","outlet"],"mappings":";;;AAAA;AACA;AAKA,4FACO,SAASA,gBAAAA,CAAiBC,IAAsB,EAAA;IACnD,OAAOA,IAAAA,CAAKC,MAAM,EAAEC,eAAAA;AACxB;AAEA;;;;;;;AAOC,IACM,SAASC,yBAAAA,CAA0BH,IAAsB,EAAEI,YAA4DL,gBAAgB,EAAA;AAC1I,IAAA,MAAMM,SAASD,SAAAA,CAAUJ,IAAAA,CAAAA;AACzB,IAAA,IAAIK,WAAWC,SAAAA,IAAaN,IAAAA,CAAKC,MAAM,KAAKK,WAAW,OAAOA,SAAAA;AAE9D,IAAA,MAAMC,QAAAA,GAAWP,IAAAA,CAAKC,MAAM,CAACC,eAAe;AAC5C,IAAA,MAAMM,WAAAA,GAAoC;AAAEC,QAAAA,IAAAA,EAAMC,gBAAgBC,MAAM;QAAEC,MAAAA,EAAQZ,IAAAA,CAAKC,MAAM,CAACW,MAAM;AAAEP,QAAAA;AAAO,KAAA;IAC7G,IAAIE,QAAAA,KAAaD,SAAAA,IAAaC,QAAAA,CAASM,UAAU,CAAC,CAAA,EAAGb,IAAAA,CAAKC,MAAM,CAACW,MAAM,CAAC,CAAC,CAAC,GAAGJ,WAAAA,CAAYM,OAAO,GAAGP,QAAAA,CAASQ,SAAS,CAACf,IAAAA,CAAKC,MAAM,CAACW,MAAM,CAACI,MAAM,GAAG,CAAA,CAAA;IAClJ,IAAIhB,IAAAA,CAAKiB,IAAI,KAAKC,WAAAA,EAAaV,YAAYW,MAAM,GAAGnB,KAAKiB,IAAI;IAC7D,OAAOT,WAAAA;AACX;;"}