@dosgato/templating 0.0.111 → 0.0.113

package/dist/apitemplate.d.ts

@@ -80,6 +80,17 @@ export interface APITemplate<DataType> {
      * by this function will also be scanned for links.
      */
     getFulltext?: FulltextGatheringFn<DataType>;
+    /**
+     * The available component list in the main content area can get very long, among others. Therefore, each
+     * template may set a displayCategory and any templates that share a displayCategory will be grouped together
+     * underneath one tab when a user is presented with a choice of template.
+     *
+     * If a displayCategory is not set, there will be a default category like 'Standard'. If only one category
+     * exists for a group of available components, the tabs will not be shown at all. This means you do not have
+     * to bother setting displayCategory for minor cases like different kinds of slides in a slider (until there
+     * are so many that it becomes a good idea!).
+     */
+    displayCategory?: string;
 }
 export interface APIComponentTemplate<DataType extends ComponentData = any> extends APITemplate<DataType> {
     type: 'component';

package/dist/links.d.ts

@@ -71,6 +71,7 @@ export interface DataLink {
  */
 export interface DataFolderLink {
     type: 'datafolder';
+    templateKey: string;
     id: string;
     siteId?: string;
     path: string;

package/dist/render.d.ts

@@ -1,5 +1,12 @@
 import { ContextBase, DataData, PageData, PageRecord, PageRecordOptionalData } from './component.js';
 import { AssetFolderLink, AssetLink, DataFolderLink, DataLink, LinkDefinition, PageLink } from './links.js';
+/**
+ * Safely encapsulates `content` in header tags based on the `ctx` context passed and adds any passed `attributes` to the header tagging.
+ * If the headerLevel passed through `ctx` is outside the range of 1..6 the header tag generated is normalized to the nearest value of 1 or 6.
+ * @returns An empty string if content is blank, undefined, or null - else an h<1..6> encapsulated content with attributes added to the encapsulating tag.
+ * @example ```
+ *   printHeader(this.renderCtx, htmlEncode(this.data.title), {class: 'some-extra-cssclass'})
+ * ``` */
 export declare function printHeader(ctx: ContextBase, content: string | undefined | null, attributes?: Record<string, string>): string;
 export declare function advanceHeader<T extends ContextBase>(ctx: T, content: string | undefined | null): T;
 export interface PictureResize {
@@ -160,7 +167,8 @@ export interface APIClient {
          * Return pages beneath this path
          *
          * For instance, if you set this to '/site1' you will get back ['/site1/about',
-         * '/site1/history', '/site1/history/traditions', ...etc]
+         * '/site1/history', '/site1/history/traditions', ...etc] but you will NOT get
+         * back the '/site1' page.
          *
          * If you do not set `beneath`, you will get back an array that contains only
          * the root page of the pagetree you are in.

package/dist/render.js

@@ -1,4 +1,11 @@
 import { htmlEncode, isBlank, isNotEmpty } from 'txstate-utils';
+/**
+ * Safely encapsulates `content` in header tags based on the `ctx` context passed and adds any passed `attributes` to the header tagging.
+ * If the headerLevel passed through `ctx` is outside the range of 1..6 the header tag generated is normalized to the nearest value of 1 or 6.
+ * @returns An empty string if content is blank, undefined, or null - else an h<1..6> encapsulated content with attributes added to the encapsulating tag.
+ * @example ```
+ *   printHeader(this.renderCtx, htmlEncode(this.data.title), {class: 'some-extra-cssclass'})
+ * ``` */
 export function printHeader(ctx, content, attributes) {
     if (isBlank(content))
         return '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.111",
+  "version": "0.0.113",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {