npm - @dosgato/templating - Versions diffs - 1.1.17 → 1.1.18 - Mend

@dosgato/templating 1.1.17 → 1.1.18

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.

Files changed (5) hide show

package/dist/component.d.ts CHANGED Viewed

@@ -175,8 +175,8 @@ export declare abstract class Component<DataType extends ComponentData = any, Fe
      * left open to protect overall page integrity, and fix header levels for accessibility.
      *
      * For instance, an editor supplies a title to be placed above some rich editor content. The
-     * title uses an <h2>, so the headers inside the rich editor content should start at <h3> and
-     * should not use <h1> or <h2>.
+     * title uses an `<h2>`, so the headers inside the rich editor content should start at `<h3>` and
+     * should not use `<h1>` or `<h2>`.
      *
      * Setting headerLevel: 3 instructs the renderRichText function to analyze and rebalance the header
      * structure of the content so that if it had an h2, it woud be replaced with an h3. Additionally,
@@ -557,7 +557,7 @@ export interface RenderComponentsOpts {
     skipContent?: boolean;
     /**
      * Provide a function that wraps each component, e.g.
-     * ({ output }) => `<li>${output}</li>`
+     * `({ output }) => \`<li>${output}</li>\``
      *
      * Wrap receives a lot of optional paramaters so that you can customize the behavior. For
      * instance, you may want to wrap the content but not the edit bar, or vice versa. See
@@ -640,7 +640,7 @@ export declare abstract class Page<DataType extends PageData = any, FetchedType
     /**
      * This is a bunch of javascript and CSS and meta tags managed by the DosGato engine. It will
      * be filled by the rendering server and your render function for your page template
-     * should place include it in the <head> element
+     * should place include it in the `<head>` element
      */
     headContent: string;
     /**

package/dist/component.js CHANGED Viewed

@@ -358,7 +358,7 @@ export class Page extends Component {
     /**
      * This is a bunch of javascript and CSS and meta tags managed by the DosGato engine. It will
      * be filled by the rendering server and your render function for your page template
-     * should place include it in the <head> element
+     * should place include it in the `<head>` element
      */
     headContent;
     /**

package/dist/render.d.ts CHANGED Viewed

@@ -17,9 +17,9 @@ export interface PictureResize {
     src: string;
 }
 export interface PictureAttributes {
-    /** string appropriate for the src attribute of the default <img> tag */
+    /** string appropriate for the src attribute of the default `<img>` tag */
     src: string;
-    /** string appropriate for the srcset attribute of the default <img> tag, or use widths array to reconstruct */
+    /** string appropriate for the srcset attribute of the default `<img>` tag, or use widths array to reconstruct */
     srcset: string;
     /**
      * When an image link cannot be found, we still return the src and srcset with a non-working path so that the
@@ -36,11 +36,11 @@ export interface PictureAttributes {
     width: number;
     /** the original intrinsic height of the image uploaded by the editor */
     height: number;
-    /** a list of alternate formats like AVIF or WEBP and their resizes, useful for creating <source> tags */
+    /** a list of alternate formats like AVIF or WEBP and their resizes, useful for creating `<source>` tags */
     alternates: {
-        /** the mime type of this alternate source, useful for the type attribute on a <source> tag */
+        /** the mime type of this alternate source, useful for the type attribute on a `<source>` tag */
         mime: string;
-        /** the full srcset for the <source> tag, or use widths array to reconstruct */
+        /** the full srcset for the `<source>` tag, or use widths array to reconstruct */
         srcset: string;
         /** a list of available widths in case you want to filter some out and recreate the srcset */
         widths: PictureResize[];
@@ -187,7 +187,7 @@ export interface APIClient {
     getAssetsByLink: (link: AssetLink | AssetFolderLink | string, recursive?: boolean) => Promise<AssetRecord[]>;
     /**
      * This function will retrieve information about an image to help you construct responsive HTML
-     * for a <picture> element including the <img> and all <source> tags.
+     * for a `<picture>` element including the `<img>` and all `<source>` tags.
      *
      * The alt text it returns will be the default alternative text from the asset repository. Alt
      * text gathered from a template's dialog should generally take precedence (though the dialog may

package/dist/uitemplate.d.ts CHANGED Viewed

@@ -43,7 +43,7 @@ export interface UITemplateBase {
      * during render. For instance, to set the id on an HTML element for reference by other
      * components or code.
      *
-     * If your component has a dialog, dosgato-dialog has a <FieldIdentifier> component for this;
+     * If your component has a dialog, dosgato-dialog has a `<FieldIdentifier>` component for this;
      * it's invisible but either creates or maintains a random string.
      *
      * If your component has no dialog but still needs an identifier, you can name a property
@@ -326,7 +326,7 @@ export interface UIConfig {
      */
     environmentBackgroundColor?: (environmentConfig: any) => string | undefined;
     /**
-     * Page title for the <head>
+     * Page title for the `<head>`
      */
     title?: string;
     /**

package/package.json CHANGED Viewed

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