@gravity-ui/page-constructor 8.15.0 → 8.16.0

package/build/docs/sub-blocks/PriceDetailed.md

@@ -0,0 +1,74 @@
+# PriceDetailed
+
+> ⚠️ **Deprecated.** This sub-block is deprecated and will be removed in a future major release. Prefer [`PriceCard`](./PriceCard.md) for pricing cards.
+
+Renders a detailed pricing comparison table: each item has a title, a per-unit description, an optional label, and a list of details (either a marked list or a settings list). Supports combined or separate layout, foldable details, and per-color default label text.
+
+## Sub-block type
+
+`type: 'price-detailed'`
+
+## Used in
+
+Accepted as `children` by `CardLayout`, `Slider`, `SliderOld`.
+
+## Example
+
+```json
+{
+  "type": "price-detailed",
+  "priceType": "settings",
+  "description": {"titleSize": "l", "descriptionSize": "m", "titleColor": "cornflower"},
+  "details": {"titleSize": "s", "descriptionSize": "m"},
+  "items": [
+    {
+      "title": "Free",
+      "detailedTitle": "",
+      "description": "For use by individuals and small teams",
+      "label": {"color": "blue", "text": "Free", "size": "s"},
+      "items": [{"title": "up to 5 users", "description": "up to 5 users"}]
+    }
+  ]
+}
+```
+
+## Properties
+
+| Property                      | Type                                      | Default        | Description                                                                   |
+| ----------------------------- | ----------------------------------------- | -------------- | ----------------------------------------------------------------------------- |
+| `type` _required_             | `'price-detailed'`                        | —              | Sub-block discriminator.                                                      |
+| `when`                        | `string`                                  | —              | Conditional rendering expression.                                             |
+| `animated`                    | `boolean`                                 | —              | Enables scroll-triggered entrance animation.                                  |
+| `items` _required_            | `PriceItem[]`                             | —              | Pricing columns/rows. See below.                                              |
+| `description`                 | `object`                                  | —              | Sizing/color overrides for the description block.                             |
+| `description.titleSize`       | `'xs' \| 's' \| 'sm' \| 'm' \| 'l'`       | `'l'`          | Description title size.                                                       |
+| `description.descriptionSize` | `'xs' \| 's' \| 'sm' \| 'm' \| 'l'`       | `'m'`          | Description body size.                                                        |
+| `description.titleColor`      | `'cornflower' \| 'black'`                 | `'cornflower'` | Description title color.                                                      |
+| `details`                     | `object`                                  | —              | Sizing overrides for the details block.                                       |
+| `details.titleSize`           | `'xs' \| 's' \| 'sm' \| 'm' \| 'l'`       | `'s'`          | Details title size.                                                           |
+| `details.descriptionSize`     | `'xs' \| 's' \| 'sm' \| 'm' \| 'l'`       | `'m'`          | Details body size.                                                            |
+| `priceType`                   | `'marked-list' \| 'settings'`             | `'settings'`   | Layout of each item's `items` list.                                           |
+| `numberGroupItems`            | `3 \| 4 \| 5`                             | —              | Items per row in the combined layout.                                         |
+| `isCombined`                  | `boolean`                                 | `false`        | Use the combined grid layout instead of separate columns.                     |
+| `useMixedView`                | `boolean`                                 | `false`        | Mix list item views (extended details on desktop, collapse on tablet/mobile). |
+| `foldable`                    | `{title*required, size?, titleColor?}`    | —              | Makes the details section collapsible with a toggle.                          |
+| `labelsDefaultText`           | `{blue?, green?, yellow?, purple?, red?}` | —              | Default text used for each label color when an item label has no `text`.      |
+
+### `PriceItem` object
+
+| Property                 | Type                                           | Default | Description                                                                                                                      |
+| ------------------------ | ---------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `title` _required_       | `string`                                       | —       | Plan title (e.g. `"Free"`, `"100$"`).                                                                                            |
+| `description` _required_ | `string` (YFM)                                 | —       | Plan description.                                                                                                                |
+| `detailedTitle`          | `string`                                       | —       | Suffix/qualifier shown next to the title (e.g. `"/ month*"`).                                                                    |
+| `label`                  | `{color*required, text?, size?}`               | —       | Colored label badge. `color`: `'blue' \| 'green' \| 'yellow' \| 'purple' \| 'red'`. `size`: `'xs' \| 's' \| 'sm' \| 'm' \| 'l'`. |
+| `items`                  | `PriceDetailsList[] \| PriceDetailsSettings[]` | —       | Detail list. With `priceType: 'marked-list'` each item requires `text`; with `'settings'` each requires `title` + `description`. |
+| `analyticsEvents`        | `AnalyticsEvent \| AnalyticsEvent[]`           | —       | Analytics events.                                                                                                                |
+
+## Themed values
+
+This sub-block does not consume themed media; sizing/color controls above are explicit.
+
+## Storybook
+
+[PriceDetailed](https://preview.gravity-ui.com/page-constructor/?path=/docs/components-cards-pricedetailed-deprecated--docs)

package/build/docs/sub-blocks/Quote.md

@@ -0,0 +1,74 @@
+# Quote
+
+Renders a customer testimonial / quote card: a logo, the quote body, an optional author (name + avatar + description), and an optional CTA button. Paired with a large image on the side.
+
+## Sub-block type
+
+`type: 'quote'`
+
+## Used in
+
+Accepted as `children` by `CardLayout`, `Slider`, `SliderOld`; also usable as a card payload in `FilterBlock` items.
+
+## Example
+
+```json
+{
+  "type": "quote",
+  "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+  "quoteType": "chevron",
+  "theme": "light",
+  "image": {
+    "light": {"src": "/assets/img_6-12_light.png"},
+    "dark": {"src": "/assets/img_8-12_dark.png"}
+  },
+  "logo": {"src": "/assets/logo.png", "alt": "Company logo"},
+  "author": {
+    "firstName": "Lorem",
+    "secondName": "ipsum",
+    "description": "CEO, Acme",
+    "avatar": "/assets/avatar.png"
+  },
+  "button": {
+    "text": "Read the case study",
+    "theme": "outlined",
+    "url": "https://example.com"
+  }
+}
+```
+
+## Properties
+
+| Property           | Type                            | Default     | Description                                                                                                                                  |
+| ------------------ | ------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `type` _required_  | `'quote'`                       | —           | Sub-block discriminator.                                                                                                                     |
+| `when`             | `string`                        | —           | Conditional rendering expression.                                                                                                            |
+| `text`             | `string`                        | —           | Quote body (plain text). Prefer `yfmText` for Markdown.                                                                                      |
+| `yfmText`          | `string` (YFM)                  | —           | Quote body in YFM Markdown (overrides `text` when set).                                                                                      |
+| `image` _required_ | `ImageProps \| {light, dark}`   | —           | Large side image. Themed: `T \| {light: T, dark: T}`.                                                                                        |
+| `logo` _required_  | `ImageProps`                    | —           | Company/personal logo shown above the quote.                                                                                                 |
+| `color`            | `string`                        | —           | Custom card background color.                                                                                                                |
+| `url`              | `string`                        | —           | Link URL for the CTA. Deprecated, prefer `button`.                                                                                           |
+| `urlTitle`         | `string`                        | —           | Title/tooltip for the CTA link. Deprecated, prefer `button`.                                                                                 |
+| `buttonText`       | `string`                        | —           | CTA button text. Deprecated, prefer `button`.                                                                                                |
+| `button`           | `ButtonProps`                   | —           | Full button configuration (preferred over `url` / `urlTitle` / `buttonText`). Available on the component model; not part of the JSON schema. |
+| `theme`            | `'light' \| 'dark'`             | `'light'`   | Text color theme.                                                                                                                            |
+| `quoteType`        | `'chevron' \| 'english-double'` | `'chevron'` | Quotation mark style. `chevron` renders `« »`, `english-double` renders `“ ”`.                                                               |
+| `author`           | `object`                        | —           | Author block. See below.                                                                                                                     |
+
+### `author` object
+
+| Property                | Type                          | Default | Description                |
+| ----------------------- | ----------------------------- | ------- | -------------------------- |
+| `firstName` _required_  | `string`                      | —       | Author first name.         |
+| `secondName` _required_ | `string`                      | —       | Author second name.        |
+| `avatar`                | `ImageProps \| {light, dark}` | —       | Avatar image (themed).     |
+| `description`           | `string` (YFM)                | —       | Author role / description. |
+
+## Themed values
+
+`image` and `author.avatar` accept `T | {light: T, dark: T}` and are resolved at runtime via the active theme.
+
+## Storybook
+
+[Quote](https://preview.gravity-ui.com/page-constructor/?path=/docs/components-cards-quote--docs)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/page-constructor",
-  "version": "8.15.0",
+  "version": "8.16.0",
   "description": "Gravity UI Page Constructor",
   "license": "MIT",
   "type": "commonjs",
@@ -137,8 +137,9 @@
     "@commitlint/config-conventional": "^19.6.0",
     "@diplodoc/transform": "^4.57.1",
     "@gravity-ui/eslint-config": "^3.2.0",
-    "@gravity-ui/gulp-utils": "^1.0.3",
+    "@gravity-ui/gulp-utils": "^1.1.1",
     "@gravity-ui/prettier-config": "^1.1.0",
+    "@gravity-ui/readme-validator": "^1.3.0",
     "@gravity-ui/stylelint-config": "^4.0.1",
     "@gravity-ui/tsconfig": "^1.0.0",
     "@gravity-ui/uikit": "^7.13.1",