npm - marko - Versions diffs - 5.35.25 → 5.35.27 - Mend

marko 5.35.25 → 5.35.27

Files changed (4) hide show

package/docs/body-content.md CHANGED Viewed

@@ -111,9 +111,9 @@ _components/layout.marko_
 > **ProTip:** The `renderBody` property can be omitted. You could use `<${input.heading}/>`, for example.
-### Repeatable attribute tags
+### Repeated body content
-Attribute tags can be repeated. Rendering the same attribute tag name multiple times will cause the input value for that attribute to become an array instead of an single object.
+When an attribute tag is repeated, the child component can consume all instances using the [iterable protocol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol).
 This allows us to, for example, build a custom table component which allows its user to specify any number of columns, while still giving the user control over how each column is rendered.
@@ -131,15 +131,11 @@ _Marko Source:_
 ```
 > _Note_
-> Attribute tags are _repeatable_.
->
-> - Zero: if you don't pass any `@column` tags, the `fancy-table` receives `undefined`.
-> - One: if you pass a single `@column` tag, the `fancy-table` receives a single attribute tag object. (For convenience this object is [iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol) meaning it can be directly passed to the `<for>` tag.)
-> - Many: if you pass multiple `@column` tags, the `fancy-table` receives an array of attribute tags.
->   For TypeScript the [`Marko.AttrTag` or `Marko.RepeatableAttrTag` helpers](./typescript.md#built-in-marko-types) should be used here.
+> For TypeScript the [`Marko.AttrTag` helper](./typescript.md#built-in-marko-types) should be used here.
 > _Protip_
-> To `.map`, `.filter` or otherwise work with attribute tags as an array:
+> Since attribute tags are iterable you could pass `input.column` to a `for of` loop, or `[...spread]` it into an array.
+> To `.map`, `.filter` or otherwise work with attribute tags as an array you can use the following pattern:
 >
 > ```marko
 > $ const columns = [...input.column || []];
@@ -212,7 +208,7 @@ _Marko Source:_
 </fancy-table>
 ```
-Now, each object in the `input.column` array will contain a `heading` property in addition to its `renderBody`. We can use another `<for>` and render the headings in `<th>` tags:
+Now, each attribute tag in `input.column` will contain a `heading` property in addition to its `renderBody`. We can use another `<for>` and render the headings in `<th>` tags:
 _components/fancy-table/index.marko:_
@@ -256,21 +252,6 @@ _HTML Output:_
 </table>
 ```
-> _Note_
-> You may also specify that the attribute tag can be repeated in a [`marko-tag.json`](./marko-json.md#single-component-definition) file.
-> This will cause an array to _always_ be passed if there are any items, rather than working up from `undefined`, single object and then an array.
->
-> _components/fancy-table/marko-tag.json:_
->
-> ```js
-> {
->     "@data": "array",
->     "<column>": {
->         "is-repeated": true
->     }
-> }
-> ```
 ### Nested attribute tags
 Continuing to build on our example, what if we want to add some custom content or even components into the column headings? In this case, we can extend our `<fancy-table>` to use nested attribute tags. We'll now have `<@heading>` and `<@cell>` tags nested under `<@column>`. This gives users of our tag full control over how to render both column headings and the cells within the column!

package/docs/typescript.md CHANGED Viewed

@@ -137,10 +137,9 @@ Marko exposes [type definitions](https://github.com/marko-js/marko/blob/main/pac
   - Helpers to extract the input and return types native tags (when a string is passed) or a custom tag.
 - **`Marko.BodyParameters<Body>`** and **`Marko.BodyReturnType<Body>`**
   - Helpers to extract the parameters and return types from the specified `Marko.Body`
-- **`Marko.AttrTag<T>`** and **`Marko.RepeatableAttrTag<T>`**
+- **`Marko.AttrTag<T>`**
   - Used to represent types for [attributes tags](./body-content.md#named-body-content)
-  - `Marko.AttrTag<T>`: A single attribute tag
-  - `Marko.RepeatableAttrTag<T>`: One or more attribute tags
+  - A single attribute tag, with a `[Symbol.iterator]` to consume any repeated tags.
 ### Typing `renderBody`

package/index.d.ts CHANGED Viewed

@@ -310,10 +310,14 @@ declare global {
       removeAllListeners(eventName?: PropertyKey): this;
     }
-    export type AttrTag<T> = T & Iterable<AttrTag<T>>;
-    export type RepeatableAttrTag<T> =
-      | AttrTag<T>
-      | [AttrTag<T>, AttrTag<T>, ...AttrTag<T>[]];
+    export type AttrTag<T> = T & {
+      [Symbol.iterator](): T;
+    };
+    /**
+     * @deprecated Prefer to use AttrTag
+     */
+    export type RepeatableAttrTag<T> = AttrTag<T>;
     export interface NativeTag<
       Input extends Record<string, any>,
@@ -341,10 +345,10 @@ declare global {
                 length: infer Length;
               }
               ? number extends Length
-                ? { value?: Args }
+                ? Args[0] | undefined
                 : 0 extends Length
-                  ? { value?: [] }
-                  : { value: Args }
+                  ? undefined
+                  : Args[0]
               : never
             : never;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "marko",
-  "version": "5.35.25",
+  "version": "5.35.27",
   "description": "UI Components + streaming, async, high performance, HTML templating for Node.js and the browser.",
   "keywords": [
     "front-end",
@@ -66,8 +66,8 @@
     "build": "babel ./src --out-dir ./dist --extensions .js --copy-files --config-file ../../babel.config.js --env-name=production"
   },
   "dependencies": {
-    "@marko/compiler": "^5.37.18",
-    "@marko/translator-default": "^6.0.18",
+    "@marko/compiler": "^5.37.19",
+    "@marko/translator-default": "^6.0.19",
     "app-module-path": "^2.2.0",
     "argly": "^1.2.0",
     "browser-refresh-client": "1.1.4",