@divkitframework/jsonbuilder 29.3.0 → 29.5.0

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.
@@ -327,8 +327,8 @@ interface IDivAction {
327
327
  */
328
328
  download_callbacks?: Type<IDivDownloadCallbacks>;
329
329
  /**
330
- * This parameter allows you to disable the action for any reason. When an action is disabled, it
331
- * stops responding to the event associated with it (click, change in visibility, etc.).
330
+ * The parameter disables the action. Disabled actions stop listening to their associated event
331
+ * (clicks, changes in visibility, and so on).
332
332
  */
333
333
  is_enabled?: Type<IntBoolean | DivExpression>;
334
334
  /**
@@ -796,29 +796,30 @@ interface DivCircleShapeProps {
796
796
 
797
797
  interface IDivCollectionItemBuilder {
798
798
  /**
799
- * Data that will be used to create collection items.
799
+ * Data that will be used to create collection elements.
800
800
  */
801
801
  data: Type<unknown[] | DivExpression>;
802
802
  /**
803
- * Prefix for accessing the next `data` element in the prototype.
803
+ * Name for accessing the next `data` element in the prototype. Working with this element is like
804
+ * working with DivKit dictionaries.
804
805
  */
805
- data_element_prefix?: Type<string>;
806
+ data_element_name?: Type<string>;
806
807
  /**
807
- * Array of `div` from which the collection items will be created.
808
+ * Array of `div` elements from which the collection elements will be created.
808
809
  */
809
810
  prototypes: Type<NonEmptyArray<IDivCollectionItemBuilderPrototype>>;
810
811
  }
811
812
  interface IDivCollectionItemBuilderPrototype {
812
813
  /**
813
- * `Div` from which the collection items will be created. In `Div`, you can use expressions using
814
- * data from `data`, to access the next `data` element, you need to use the same prefix as in
815
- * `data_element_prefix`.
814
+ * `Div` from which the collection elements will be created. In `Div`, you can use expressions
815
+ * using data from `data`. To access the next `data` element, you need to use the same prefix as
816
+ * in `data_element_prefix`.
816
817
  */
817
818
  div: Type<Div>;
818
819
  /**
819
- * A condition that is used to select a prototype for the next item in the collection. If there
820
- * is more than 1 true condition, the prototype that is earlier will be selected. If none of the
821
- * conditions are met, the data element will be skipped.
820
+ * A condition that is used to select the prototype for the next element in the collection. If
821
+ * there is more than 1 true condition, the earlier prototype is selected. If none of the
822
+ * conditions are met, the element from `data` is skipped.
822
823
  */
823
824
  selector?: Type<IntBoolean | DivExpression>;
824
825
  }
@@ -876,7 +877,7 @@ declare class DivContainer<T extends DivContainerProps = DivContainerProps> {
876
877
  */
877
878
  border?: Type<IDivBorder>;
878
879
  /**
879
- * Parameter that determines whether child elements are bounded by the parent's boundaries.
880
+ * Enables the bounding of child elements by the parent's borders.
880
881
  */
881
882
  clip_to_bounds?: Type<IntBoolean | DivExpression>;
882
883
  /**
@@ -924,7 +925,7 @@ declare class DivContainer<T extends DivContainerProps = DivContainerProps> {
924
925
  */
925
926
  id?: Type<string>;
926
927
  /**
927
- * A way to set collection items dynamically using data and prototypes.
928
+ * Sets collection elements dynamically using `data` and `prototypes`.
928
929
  */
929
930
  item_builder?: Type<IDivCollectionItemBuilder>;
930
931
  /**
@@ -1071,7 +1072,7 @@ interface DivContainerPropsBase {
1071
1072
  */
1072
1073
  border?: Type<IDivBorder>;
1073
1074
  /**
1074
- * Parameter that determines whether child elements are bounded by the parent's boundaries.
1075
+ * Enables the bounding of child elements by the parent's borders.
1075
1076
  */
1076
1077
  clip_to_bounds?: Type<IntBoolean | DivExpression>;
1077
1078
  /**
@@ -1119,7 +1120,7 @@ interface DivContainerPropsBase {
1119
1120
  */
1120
1121
  id?: Type<string>;
1121
1122
  /**
1122
- * A way to set collection items dynamically using data and prototypes.
1123
+ * Sets collection elements dynamically using `data` and `prototypes`.
1123
1124
  */
1124
1125
  item_builder?: Type<IDivCollectionItemBuilder>;
1125
1126
  /**
@@ -1227,7 +1228,7 @@ interface DivContainerProps0 extends DivContainerPropsBase {
1227
1228
  }
1228
1229
  interface DivContainerProps1 extends DivContainerPropsBase {
1229
1230
  /**
1230
- * A way to set collection items dynamically using data and prototypes.
1231
+ * Sets collection elements dynamically using `data` and `prototypes`.
1231
1232
  */
1232
1233
  item_builder: Type<IDivCollectionItemBuilder>;
1233
1234
  }
@@ -1626,8 +1627,8 @@ interface IDivDisappearAction {
1626
1627
  */
1627
1628
  download_callbacks?: Type<IDivDownloadCallbacks>;
1628
1629
  /**
1629
- * This parameter allows you to disable the action for any reason. When an action is disabled, it
1630
- * stops responding to the event associated with it (click, change in visibility, etc.).
1630
+ * The parameter disables the action. Disabled actions stop listening to their associated event
1631
+ * (clicks, changes in visibility, and so on).
1631
1632
  */
1632
1633
  is_enabled?: Type<IntBoolean | DivExpression>;
1633
1634
  /**
@@ -2051,10 +2052,10 @@ declare class DivGallery<T extends DivGalleryProps = DivGalleryProps> {
2051
2052
  */
2052
2053
  scroll_mode?: Type<DivGalleryScrollMode | DivExpression>;
2053
2054
  /**
2054
- * Scrollbar behaviour. Hidden by default. On different platforms, the scrollbar may occupy a
2055
- * different space, since this is a user setting. Consider this in sizes. `none` scrollbar is
2056
- * hidden.`auto` — scrollbar is shown if there is not enough space and is necessary out the
2057
- * current platform.
2055
+ * Scrollbar behavior. Hidden by default. When choosing a gallery size, keep in mind that the
2056
+ * scrollbar may have a different height and width depending on the platform and user settings.
2057
+ * `none` — the scrollbar is hidden.`auto` the scrollbar is shown if there isn't enough space
2058
+ * and it needs to be displayed on the current platform.
2058
2059
  */
2059
2060
  scrollbar?: Type<DivGalleryScrollbar | DivExpression>;
2060
2061
  /**
@@ -2228,10 +2229,10 @@ interface DivGalleryProps {
2228
2229
  */
2229
2230
  scroll_mode?: Type<DivGalleryScrollMode | DivExpression>;
2230
2231
  /**
2231
- * Scrollbar behaviour. Hidden by default. On different platforms, the scrollbar may occupy a
2232
- * different space, since this is a user setting. Consider this in sizes. `none` scrollbar is
2233
- * hidden.`auto` — scrollbar is shown if there is not enough space and is necessary out the
2234
- * current platform.
2232
+ * Scrollbar behavior. Hidden by default. When choosing a gallery size, keep in mind that the
2233
+ * scrollbar may have a different height and width depending on the platform and user settings.
2234
+ * `none` — the scrollbar is hidden.`auto` the scrollbar is shown if there isn't enough space
2235
+ * and it needs to be displayed on the current platform.
2235
2236
  */
2236
2237
  scrollbar?: Type<DivGalleryScrollbar | DivExpression>;
2237
2238
  /**
@@ -5857,8 +5858,8 @@ interface IDivSightAction {
5857
5858
  */
5858
5859
  download_callbacks?: Type<IDivDownloadCallbacks>;
5859
5860
  /**
5860
- * This parameter allows you to disable the action for any reason. When an action is disabled, it
5861
- * stops responding to the event associated with it (click, change in visibility, etc.).
5861
+ * The parameter disables the action. Disabled actions stop listening to their associated event
5862
+ * (clicks, changes in visibility, and so on).
5862
5863
  */
5863
5864
  is_enabled?: Type<IntBoolean | DivExpression>;
5864
5865
  /**
@@ -8362,8 +8363,8 @@ interface IDivVisibilityAction {
8362
8363
  */
8363
8364
  download_callbacks?: Type<IDivDownloadCallbacks>;
8364
8365
  /**
8365
- * This parameter allows you to disable the action for any reason. When an action is disabled, it
8366
- * stops responding to the event associated with it (click, change in visibility, etc.).
8366
+ * The parameter disables the action. Disabled actions stop listening to their associated event
8367
+ * (clicks, changes in visibility, and so on).
8367
8368
  */
8368
8369
  is_enabled?: Type<IntBoolean | DivExpression>;
8369
8370
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@divkitframework/jsonbuilder",
3
- "version": "29.3.0",
3
+ "version": "29.5.0",
4
4
  "description": "DivKit TypeScript JSON Builder",
5
5
  "main": "./dist/jsonbuilder.js",
6
6
  "module": "./dist/es/jsonbuilder.js",