cx 24.10.6 → 24.10.8

package/src/ui/layout/ContentPlaceholder.d.ts

@@ -1,18 +1,19 @@
-import * as Cx from '../../core';
-import {RenderingContext} from '../RenderingContext';
-
-interface ContentPlaceholderProps extends Cx.PureContainerProps {
-
-   name?: Cx.StringProp,
-
-   scoped?: boolean
-}
-
-export class ContentPlaceholder extends Cx.Widget<ContentPlaceholderProps> {}
-
-
-interface ContentPlaceholderScopeProps extends Cx.PureContainerProps {
-   name?: string | string[]
-}
-
-export class ContentPlaceholderScope extends Cx.Widget<ContentPlaceholderScopeProps> {}
+import * as Cx from "../../core";
+import { RenderingContext } from "../RenderingContext";
+
+interface ContentPlaceholderProps extends Cx.PureContainerProps {
+   name?: Cx.StringProp;
+
+   scoped?: boolean;
+
+   /* Set to true to allow all registered content elements to render inside the placeholder. Otherwise only one element is rendered. */
+   allowMultiple?: boolean;
+}
+
+export class ContentPlaceholder extends Cx.Widget<ContentPlaceholderProps> {}
+
+interface ContentPlaceholderScopeProps extends Cx.PureContainerProps {
+   name?: string | string[];
+}
+
+export class ContentPlaceholderScope extends Cx.Widget<ContentPlaceholderScopeProps> {}

package/src/ui/layout/ContentPlaceholder.js

@@ -1,80 +1,105 @@
-import {Widget} from '../Widget';
-import {PureContainer} from '../PureContainer';
-import {isString} from "../../util/isString";
-
-export class ContentPlaceholder extends PureContainer {
-
-   declareData() {
-      super.declareData(...arguments, {
-         name: undefined
-      });
-   }
-
-   explore(context, instance) {
-      instance.content = null;
-      let {data} = instance;
-
-      const content = context.content && context.content[data.name];
-      if (content && !this.scoped)
-         this.setContent(context, instance, content);
-      else
-         context.pushNamedValue('contentPlaceholder', data.name, (content) => {
-            this.setContent(context, instance, content);
-         });
-
-      if (this.scoped)
-         instance.unregisterContentPlaceholder = () => {
-            context.popNamedValue("contentPlaceholder", data.name);
-         };
-
-      super.explore(context, instance);
-   }
-
-   prepare(context, instance) {
-      let {content} = instance;
-      if (instance.cache('content', content) || (content && content.shouldUpdate))
-         instance.markShouldUpdate(context);
-   }
-
-   setContent(context, instance, content) {
-      instance.content = content;
-      content.contentPlaceholder = instance;
-   }
-
-   render(context, instance, key) {
-      const {content} = instance;
-      if (content)
-         return content.contentVDOM;
-
-      return super.render(context, instance, key);
-   }
-}
-
-ContentPlaceholder.prototype.name = 'body';
-ContentPlaceholder.prototype.scoped = false;
-
-Widget.alias('content-placeholder', ContentPlaceholder);
-
-export class ContentPlaceholderScope extends PureContainer {
-   init() {
-      super.init();
-
-      if (isString(this.name))
-         this.name = [this.name];
-   }
-
-   explore(context, instance) {
-      this.name.forEach(name => {
-         context.pushNamedValue('contentPlaceholder', name, null);
-         context.pushNamedValue('content', name, null);
-      });
-      super.explore(context, instance);
-   }
-
-   exploreCleanup(context, instance) {
-      this.name.forEach(name => {
-         context.popNamedValue('contentPlaceholder', name);
-         context.popNamedValue('content', name);
-      });
-   }
-}
+import { Widget } from "../Widget";
+import { PureContainer } from "../PureContainer";
+import { isString } from "../../util/isString";
+import { isNonEmptyArray } from "../../util/isNonEmptyArray";
+
+export class ContentPlaceholder extends PureContainer {
+   declareData() {
+      super.declareData(...arguments, {
+         name: undefined,
+      });
+   }
+
+   explore(context, instance) {
+      instance.content = null;
+      let { data } = instance;
+
+      if (this.allowMultiple) {
+         const contentList = context.contentList && context.contentList[data.name];
+         if (isNonEmptyArray(contentList) && !this.scoped)
+            for (let i = 0; i < contentList.length; i++) this.setContent(context, instance, contentList[i]);
+
+         // in multi mode register a callback to allow for more entries to be added
+         context.pushNamedValue("contentPlaceholder", data.name, (content) => {
+            this.setContent(context, instance, content);
+         });
+      } else {
+         const content = context.content && context.content[data.name];
+         if (content && !this.scoped) this.setContent(context, instance, content);
+         else
+            context.pushNamedValue("contentPlaceholder", data.name, (content) => {
+               this.setContent(context, instance, content);
+            });
+      }
+
+      if (this.scoped)
+         instance.unregisterContentPlaceholder = () => {
+            context.popNamedValue("contentPlaceholder", data.name);
+         };
+
+      super.explore(context, instance);
+   }
+
+   prepare(context, instance) {
+      let { content } = instance;
+      if (this.allowMultiple) {
+         let contentId = "";
+         let shouldUpdate = false;
+         if (content) {
+            for (let i = 0; i < content.length; i++) {
+               let c = content[i];
+               contentId += c.id + "+";
+               shouldUpdate = shouldUpdate || c.shouldUpdate;
+            }
+         }
+         if (instance.cache("content", contentId) || shouldUpdate) instance.markShouldUpdate(context);
+      } else if (instance.cache("content", content) || (content && content.shouldUpdate))
+         instance.markShouldUpdate(context);
+   }
+
+   setContent(context, instance, content) {
+      if (this.allowMultiple) {
+         if (instance.content == null) instance.content = [];
+         instance.content.push(content);
+      } else instance.content = content;
+      content.contentPlaceholder = instance;
+   }
+
+   render(context, instance, key) {
+      const { content } = instance;
+      if (!content) return super.render(context, instance, key);
+      if (this.allowMultiple) return content.map((x) => x.contentVDOM);
+      return content.contentVDOM;
+   }
+}
+
+ContentPlaceholder.prototype.name = "body";
+ContentPlaceholder.prototype.scoped = false;
+ContentPlaceholder.prototype.allowMultiple = false;
+
+Widget.alias("content-placeholder", ContentPlaceholder);
+
+export class ContentPlaceholderScope extends PureContainer {
+   init() {
+      super.init();
+
+      if (isString(this.name)) this.name = [this.name];
+   }
+
+   explore(context, instance) {
+      this.name.forEach((name) => {
+         context.pushNamedValue("contentPlaceholder", name, null);
+         context.pushNamedValue("content", name, null);
+         context.pushNamedValue("contentList", name, []);
+      });
+      super.explore(context, instance);
+   }
+
+   exploreCleanup(context, instance) {
+      this.name.forEach((name) => {
+         context.popNamedValue("contentPlaceholder", name);
+         context.popNamedValue("content", name);
+         context.popNamedValue("contentList", name);
+      });
+   }
+}