@divkitframework/jsonbuilder 32.6.0 → 32.7.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.
@@ -348,7 +348,7 @@ declare type DivAccessibilityType = 'none' | 'button' | 'image' | 'text' | 'edit
348
348
  */
349
349
  interface IDivAction {
350
350
  /**
351
- * Callbacks that are called after data loading.
351
+ * Callbacks that are called after [data loading](../../interaction#loading-data).
352
352
  */
353
353
  download_callbacks?: Type<IDivDownloadCallbacks>;
354
354
  /**
@@ -392,7 +392,8 @@ interface IDivAction {
392
392
  target?: Type<DivActionTarget | DivExpression>;
393
393
  typed?: Type<DivActionTyped>;
394
394
  /**
395
- * URL. Possible values: `url` or `div-action://`.
395
+ * URL. Possible values: `url` or `div-action://`. To learn more, see [Interaction with
396
+ * elements](../../interaction).
396
397
  */
397
398
  url?: Type<string | DivExpression>;
398
399
  }
@@ -1269,8 +1270,7 @@ interface IDivBase {
1269
1270
  */
1270
1271
  id?: Type<string>;
1271
1272
  /**
1272
- * Provides data on the actual size of the element. The size is calculated without taking into
1273
- * account the margins of the element itself.
1273
+ * Provides data on the actual size of the element.
1274
1274
  *
1275
1275
  * Platforms: android, ios, web
1276
1276
  */
@@ -1859,8 +1859,7 @@ declare class DivContainer<T extends DivContainerProps = DivContainerProps> {
1859
1859
  */
1860
1860
  layout_mode?: Type<DivContainerLayoutMode | DivExpression>;
1861
1861
  /**
1862
- * Provides data on the actual size of the element. The size is calculated without taking into
1863
- * account the margins of the element itself.
1862
+ * Provides data on the actual size of the element.
1864
1863
  *
1865
1864
  * Platforms: android, ios, web
1866
1865
  */
@@ -2166,8 +2165,7 @@ interface DivContainerPropsBase {
2166
2165
  */
2167
2166
  layout_mode?: Type<DivContainerLayoutMode | DivExpression>;
2168
2167
  /**
2169
- * Provides data on the actual size of the element. The size is calculated without taking into
2170
- * account the margins of the element itself.
2168
+ * Provides data on the actual size of the element.
2171
2169
  *
2172
2170
  * Platforms: android, ios, web
2173
2171
  */
@@ -2503,8 +2501,7 @@ declare class DivCustom<T extends DivCustomProps = DivCustomProps> {
2503
2501
  */
2504
2502
  items?: Type<NonEmptyArray<Div>>;
2505
2503
  /**
2506
- * Provides data on the actual size of the element. The size is calculated without taking into
2507
- * account the margins of the element itself.
2504
+ * Provides data on the actual size of the element.
2508
2505
  *
2509
2506
  * Platforms: android, ios, web
2510
2507
  */
@@ -2696,8 +2693,7 @@ interface DivCustomProps {
2696
2693
  */
2697
2694
  items?: Type<NonEmptyArray<Div>>;
2698
2695
  /**
2699
- * Provides data on the actual size of the element. The size is calculated without taking into
2700
- * account the margins of the element itself.
2696
+ * Provides data on the actual size of the element.
2701
2697
  *
2702
2698
  * Platforms: android, ios, web
2703
2699
  */
@@ -2843,7 +2839,7 @@ interface IDivDisappearAction {
2843
2839
  */
2844
2840
  disappear_duration?: Type<number | DivExpression>;
2845
2841
  /**
2846
- * Callbacks that are called after data loading.
2842
+ * Callbacks that are called after [data loading](../../interaction#loading-data).
2847
2843
  */
2848
2844
  download_callbacks?: Type<IDivDownloadCallbacks>;
2849
2845
  /**
@@ -2877,7 +2873,8 @@ interface IDivDisappearAction {
2877
2873
  scope_id?: Type<string>;
2878
2874
  typed?: Type<DivActionTyped>;
2879
2875
  /**
2880
- * URL. Possible values: `url` or `div-action://`.
2876
+ * URL. Possible values: `url` or `div-action://`. To learn more, see [Interaction with
2877
+ * elements](../../interaction).
2881
2878
  */
2882
2879
  url?: Type<string | DivExpression>;
2883
2880
  /**
@@ -3340,8 +3337,7 @@ declare class DivGallery<T extends DivGalleryProps = DivGalleryProps> {
3340
3337
  */
3341
3338
  items?: Type<NonEmptyArray<Div>>;
3342
3339
  /**
3343
- * Provides data on the actual size of the element. The size is calculated without taking into
3344
- * account the margins of the element itself.
3340
+ * Provides data on the actual size of the element.
3345
3341
  *
3346
3342
  * Platforms: android, ios, web
3347
3343
  */
@@ -3598,8 +3594,7 @@ interface DivGalleryProps {
3598
3594
  */
3599
3595
  items?: Type<NonEmptyArray<Div>>;
3600
3596
  /**
3601
- * Provides data on the actual size of the element. The size is calculated without taking into
3602
- * account the margins of the element itself.
3597
+ * Provides data on the actual size of the element.
3603
3598
  *
3604
3599
  * Platforms: android, ios, web
3605
3600
  */
@@ -3875,8 +3870,7 @@ declare class DivGifImage<T extends DivGifImageProps = DivGifImageProps> {
3875
3870
  */
3876
3871
  id?: Type<string>;
3877
3872
  /**
3878
- * Provides data on the actual size of the element. The size is calculated without taking into
3879
- * account the margins of the element itself.
3873
+ * Provides data on the actual size of the element.
3880
3874
  *
3881
3875
  * Platforms: android, ios, web
3882
3876
  */
@@ -4160,8 +4154,7 @@ interface DivGifImageProps {
4160
4154
  */
4161
4155
  id?: Type<string>;
4162
4156
  /**
4163
- * Provides data on the actual size of the element. The size is calculated without taking into
4164
- * account the margins of the element itself.
4157
+ * Provides data on the actual size of the element.
4165
4158
  *
4166
4159
  * Platforms: android, ios, web
4167
4160
  */
@@ -4449,8 +4442,7 @@ declare class DivGrid<T extends DivGridProps = DivGridProps> {
4449
4442
  */
4450
4443
  items?: Type<NonEmptyArray<Div>>;
4451
4444
  /**
4452
- * Provides data on the actual size of the element. The size is calculated without taking into
4453
- * account the margins of the element itself.
4445
+ * Provides data on the actual size of the element.
4454
4446
  *
4455
4447
  * Platforms: android, ios, web
4456
4448
  */
@@ -4709,8 +4701,7 @@ interface DivGridProps {
4709
4701
  */
4710
4702
  items?: Type<NonEmptyArray<Div>>;
4711
4703
  /**
4712
- * Provides data on the actual size of the element. The size is calculated without taking into
4713
- * account the margins of the element itself.
4704
+ * Provides data on the actual size of the element.
4714
4705
  *
4715
4706
  * Platforms: android, ios, web
4716
4707
  */
@@ -4993,8 +4984,7 @@ declare class DivImage<T extends DivImageProps = DivImageProps> {
4993
4984
  */
4994
4985
  image_url: Type<string | DivExpression>;
4995
4986
  /**
4996
- * Provides data on the actual size of the element. The size is calculated without taking into
4997
- * account the margins of the element itself.
4987
+ * Provides data on the actual size of the element.
4998
4988
  *
4999
4989
  * Platforms: android, ios, web
5000
4990
  */
@@ -5304,8 +5294,7 @@ interface DivImageProps {
5304
5294
  */
5305
5295
  image_url: Type<string | DivExpression>;
5306
5296
  /**
5307
- * Provides data on the actual size of the element. The size is calculated without taking into
5308
- * account the margins of the element itself.
5297
+ * Provides data on the actual size of the element.
5309
5298
  *
5310
5299
  * Platforms: android, ios, web
5311
5300
  */
@@ -5657,8 +5646,7 @@ declare class DivIndicator<T extends DivIndicatorProps = DivIndicatorProps> {
5657
5646
  */
5658
5647
  items_placement?: Type<DivIndicatorItemPlacement>;
5659
5648
  /**
5660
- * Provides data on the actual size of the element. The size is calculated without taking into
5661
- * account the margins of the element itself.
5649
+ * Provides data on the actual size of the element.
5662
5650
  *
5663
5651
  * Platforms: android, ios, web
5664
5652
  */
@@ -5681,8 +5669,7 @@ declare class DivIndicator<T extends DivIndicatorProps = DivIndicatorProps> {
5681
5669
  */
5682
5670
  paddings?: Type<IDivEdgeInsets>;
5683
5671
  /**
5684
- * ID of the pager that is a data source for an indicator. If not specified, the indicator will
5685
- * automatically find the nearest pager.
5672
+ * ID of the pager that is a data source for an indicator.
5686
5673
  */
5687
5674
  pager_id?: Type<string>;
5688
5675
  /**
@@ -5907,8 +5894,7 @@ interface DivIndicatorProps {
5907
5894
  */
5908
5895
  items_placement?: Type<DivIndicatorItemPlacement>;
5909
5896
  /**
5910
- * Provides data on the actual size of the element. The size is calculated without taking into
5911
- * account the margins of the element itself.
5897
+ * Provides data on the actual size of the element.
5912
5898
  *
5913
5899
  * Platforms: android, ios, web
5914
5900
  */
@@ -5931,8 +5917,7 @@ interface DivIndicatorProps {
5931
5917
  */
5932
5918
  paddings?: Type<IDivEdgeInsets>;
5933
5919
  /**
5934
- * ID of the pager that is a data source for an indicator. If not specified, the indicator will
5935
- * automatically find the nearest pager.
5920
+ * ID of the pager that is a data source for an indicator.
5936
5921
  */
5937
5922
  pager_id?: Type<string>;
5938
5923
  /**
@@ -6114,8 +6099,7 @@ declare class DivInput<T extends DivInputProps = DivInputProps> {
6114
6099
  */
6115
6100
  disappear_actions?: Type<NonEmptyArray<IDivDisappearAction>>;
6116
6101
  /**
6117
- * Actions when pressing the 'Enter' key. Actions (if any) override the default behavior. In
6118
- * multiline inputs, pressing Enter will trigger the actions instead of adding a new line.
6102
+ * Actions when pressing the 'Enter' key. Actions (if any) override the default behavior.
6119
6103
  *
6120
6104
  * Platforms: ios, android, web
6121
6105
  */
@@ -6218,8 +6202,7 @@ declare class DivInput<T extends DivInputProps = DivInputProps> {
6218
6202
  */
6219
6203
  keyboard_type?: Type<DivInputKeyboardType | DivExpression>;
6220
6204
  /**
6221
- * Provides data on the actual size of the element. The size is calculated without taking into
6222
- * account the margins of the element itself.
6205
+ * Provides data on the actual size of the element.
6223
6206
  *
6224
6207
  * Platforms: android, ios, web
6225
6208
  */
@@ -6440,8 +6423,7 @@ interface DivInputProps {
6440
6423
  */
6441
6424
  disappear_actions?: Type<NonEmptyArray<IDivDisappearAction>>;
6442
6425
  /**
6443
- * Actions when pressing the 'Enter' key. Actions (if any) override the default behavior. In
6444
- * multiline inputs, pressing Enter will trigger the actions instead of adding a new line.
6426
+ * Actions when pressing the 'Enter' key. Actions (if any) override the default behavior.
6445
6427
  *
6446
6428
  * Platforms: ios, android, web
6447
6429
  */
@@ -6544,8 +6526,7 @@ interface DivInputProps {
6544
6526
  */
6545
6527
  keyboard_type?: Type<DivInputKeyboardType | DivExpression>;
6546
6528
  /**
6547
- * Provides data on the actual size of the element. The size is calculated without taking into
6548
- * account the margins of the element itself.
6529
+ * Provides data on the actual size of the element.
6549
6530
  *
6550
6531
  * Platforms: android, ios, web
6551
6532
  */
@@ -7440,8 +7421,7 @@ declare class DivPager<T extends DivPagerProps = DivPagerProps> {
7440
7421
  */
7441
7422
  layout_mode: Type<DivPagerLayoutMode>;
7442
7423
  /**
7443
- * Provides data on the actual size of the element. The size is calculated without taking into
7444
- * account the margins of the element itself.
7424
+ * Provides data on the actual size of the element.
7445
7425
  *
7446
7426
  * Platforms: android, ios, web
7447
7427
  */
@@ -7699,8 +7679,7 @@ interface DivPagerProps {
7699
7679
  */
7700
7680
  layout_mode: Type<DivPagerLayoutMode>;
7701
7681
  /**
7702
- * Provides data on the actual size of the element. The size is calculated without taking into
7703
- * account the margins of the element itself.
7682
+ * Provides data on the actual size of the element.
7704
7683
  *
7705
7684
  * Platforms: android, ios, web
7706
7685
  */
@@ -8355,8 +8334,7 @@ declare class DivSelect<T extends DivSelectProps = DivSelectProps> {
8355
8334
  */
8356
8335
  id?: Type<string>;
8357
8336
  /**
8358
- * Provides data on the actual size of the element. The size is calculated without taking into
8359
- * account the margins of the element itself.
8337
+ * Provides data on the actual size of the element.
8360
8338
  *
8361
8339
  * Platforms: android, ios, web
8362
8340
  */
@@ -8597,8 +8575,7 @@ interface DivSelectProps {
8597
8575
  */
8598
8576
  id?: Type<string>;
8599
8577
  /**
8600
- * Provides data on the actual size of the element. The size is calculated without taking into
8601
- * account the margins of the element itself.
8578
+ * Provides data on the actual size of the element.
8602
8579
  *
8603
8580
  * Platforms: android, ios, web
8604
8581
  */
@@ -8863,8 +8840,7 @@ declare class DivSeparator<T extends DivSeparatorProps = DivSeparatorProps> {
8863
8840
  */
8864
8841
  id?: Type<string>;
8865
8842
  /**
8866
- * Provides data on the actual size of the element. The size is calculated without taking into
8867
- * account the margins of the element itself.
8843
+ * Provides data on the actual size of the element.
8868
8844
  *
8869
8845
  * Platforms: android, ios, web
8870
8846
  */
@@ -9111,8 +9087,7 @@ interface DivSeparatorProps {
9111
9087
  */
9112
9088
  id?: Type<string>;
9113
9089
  /**
9114
- * Provides data on the actual size of the element. The size is calculated without taking into
9115
- * account the margins of the element itself.
9090
+ * Provides data on the actual size of the element.
9116
9091
  *
9117
9092
  * Platforms: android, ios, web
9118
9093
  */
@@ -9321,7 +9296,7 @@ interface DivShapeDrawableProps {
9321
9296
 
9322
9297
  interface IDivSightAction {
9323
9298
  /**
9324
- * Callbacks that are called after data loading.
9299
+ * Callbacks that are called after [data loading](../../interaction#loading-data).
9325
9300
  */
9326
9301
  download_callbacks?: Type<IDivDownloadCallbacks>;
9327
9302
  /**
@@ -9355,7 +9330,8 @@ interface IDivSightAction {
9355
9330
  scope_id?: Type<string>;
9356
9331
  typed?: Type<DivActionTyped>;
9357
9332
  /**
9358
- * URL. Possible values: `url` or `div-action://`.
9333
+ * URL. Possible values: `url` or `div-action://`. To learn more, see [Interaction with
9334
+ * elements](../../interaction).
9359
9335
  */
9360
9336
  url?: Type<string | DivExpression>;
9361
9337
  }
@@ -9507,8 +9483,7 @@ declare class DivSlider<T extends DivSliderProps = DivSliderProps> {
9507
9483
  */
9508
9484
  is_enabled?: Type<IntBoolean | DivExpression>;
9509
9485
  /**
9510
- * Provides data on the actual size of the element. The size is calculated without taking into
9511
- * account the margins of the element itself.
9486
+ * Provides data on the actual size of the element.
9512
9487
  *
9513
9488
  * Platforms: android, ios, web
9514
9489
  */
@@ -9754,8 +9729,7 @@ interface DivSliderProps {
9754
9729
  */
9755
9730
  is_enabled?: Type<IntBoolean | DivExpression>;
9756
9731
  /**
9757
- * Provides data on the actual size of the element. The size is calculated without taking into
9758
- * account the margins of the element itself.
9732
+ * Provides data on the actual size of the element.
9759
9733
  *
9760
9734
  * Platforms: android, ios, web
9761
9735
  */
@@ -10152,8 +10126,7 @@ declare class DivState<T extends DivStateProps = DivStateProps> {
10152
10126
  */
10153
10127
  id?: Type<string>;
10154
10128
  /**
10155
- * Provides data on the actual size of the element. The size is calculated without taking into
10156
- * account the margins of the element itself.
10129
+ * Provides data on the actual size of the element.
10157
10130
  *
10158
10131
  * Platforms: android, ios, web
10159
10132
  */
@@ -10430,8 +10403,7 @@ interface DivStateProps {
10430
10403
  */
10431
10404
  id?: Type<string>;
10432
10405
  /**
10433
- * Provides data on the actual size of the element. The size is calculated without taking into
10434
- * account the margins of the element itself.
10406
+ * Provides data on the actual size of the element.
10435
10407
  *
10436
10408
  * Platforms: android, ios, web
10437
10409
  */
@@ -10767,8 +10739,7 @@ declare class DivSwitch<T extends DivSwitchProps = DivSwitchProps> {
10767
10739
  */
10768
10740
  is_on_variable: Type<string>;
10769
10741
  /**
10770
- * Provides data on the actual size of the element. The size is calculated without taking into
10771
- * account the margins of the element itself.
10742
+ * Provides data on the actual size of the element.
10772
10743
  *
10773
10744
  * Platforms: android, ios, web
10774
10745
  */
@@ -10963,8 +10934,7 @@ interface DivSwitchProps {
10963
10934
  */
10964
10935
  is_on_variable: Type<string>;
10965
10936
  /**
10966
- * Provides data on the actual size of the element. The size is calculated without taking into
10967
- * account the margins of the element itself.
10937
+ * Provides data on the actual size of the element.
10968
10938
  *
10969
10939
  * Platforms: android, ios, web
10970
10940
  */
@@ -11179,8 +11149,7 @@ declare class DivTabs<T extends DivTabsProps = DivTabsProps> {
11179
11149
  */
11180
11150
  items: Type<NonEmptyArray<IDivTabsItem>>;
11181
11151
  /**
11182
- * Provides data on the actual size of the element. The size is calculated without taking into
11183
- * account the margins of the element itself.
11152
+ * Provides data on the actual size of the element.
11184
11153
  *
11185
11154
  * Platforms: android, ios, web
11186
11155
  */
@@ -11418,8 +11387,7 @@ interface DivTabsProps {
11418
11387
  */
11419
11388
  items: Type<NonEmptyArray<IDivTabsItem>>;
11420
11389
  /**
11421
- * Provides data on the actual size of the element. The size is calculated without taking into
11422
- * account the margins of the element itself.
11390
+ * Provides data on the actual size of the element.
11423
11391
  *
11424
11392
  * Platforms: android, ios, web
11425
11393
  */
@@ -11881,8 +11849,7 @@ declare class DivText<T extends DivTextProps = DivTextProps> {
11881
11849
  */
11882
11850
  images?: Type<NonEmptyArray<IDivTextImage>>;
11883
11851
  /**
11884
- * Provides data on the actual size of the element. The size is calculated without taking into
11885
- * account the margins of the element itself.
11852
+ * Provides data on the actual size of the element.
11886
11853
  *
11887
11854
  * Platforms: android, ios, web
11888
11855
  */
@@ -12272,8 +12239,7 @@ interface DivTextProps {
12272
12239
  */
12273
12240
  images?: Type<NonEmptyArray<IDivTextImage>>;
12274
12241
  /**
12275
- * Provides data on the actual size of the element. The size is calculated without taking into
12276
- * account the margins of the element itself.
12242
+ * Provides data on the actual size of the element.
12277
12243
  *
12278
12244
  * Platforms: android, ios, web
12279
12245
  */
@@ -13101,8 +13067,7 @@ declare class DivVideo<T extends DivVideoProps = DivVideoProps> {
13101
13067
  */
13102
13068
  id?: Type<string>;
13103
13069
  /**
13104
- * Provides data on the actual size of the element. The size is calculated without taking into
13105
- * account the margins of the element itself.
13070
+ * Provides data on the actual size of the element.
13106
13071
  *
13107
13072
  * Platforms: android, ios, web
13108
13073
  */
@@ -13347,8 +13312,7 @@ interface DivVideoProps {
13347
13312
  */
13348
13313
  id?: Type<string>;
13349
13314
  /**
13350
- * Provides data on the actual size of the element. The size is calculated without taking into
13351
- * account the margins of the element itself.
13315
+ * Provides data on the actual size of the element.
13352
13316
  *
13353
13317
  * Platforms: android, ios, web
13354
13318
  */
@@ -13572,7 +13536,7 @@ declare type DivVisibility = 'visible' | 'invisible' | 'gone';
13572
13536
  */
13573
13537
  interface IDivVisibilityAction {
13574
13538
  /**
13575
- * Callbacks that are called after data loading.
13539
+ * Callbacks that are called after [data loading](../../interaction#loading-data).
13576
13540
  */
13577
13541
  download_callbacks?: Type<IDivDownloadCallbacks>;
13578
13542
  /**
@@ -13606,7 +13570,8 @@ interface IDivVisibilityAction {
13606
13570
  scope_id?: Type<string>;
13607
13571
  typed?: Type<DivActionTyped>;
13608
13572
  /**
13609
- * URL. Possible values: `url` or `div-action://`.
13573
+ * URL. Possible values: `url` or `div-action://`. To learn more, see [Interaction with
13574
+ * elements](../../interaction).
13610
13575
  */
13611
13576
  url?: Type<string | DivExpression>;
13612
13577
  /**