@dcl/playground-assets 7.4.3-7935604720.commit-e16c799 → 7.4.3-7976826769.commit-bfde8e1

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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dcl/sdk",
3
3
  "description": "",
4
- "version": "7.4.3-7935604720.commit-e16c799",
4
+ "version": "7.4.3-7976826769.commit-bfde8e1",
5
5
  "author": "Decentraland",
6
6
  "dependencies": {
7
7
  "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
35
35
  },
36
36
  "types": "./index.d.ts",
37
37
  "typings": "./index.d.ts",
38
- "commit": "e16c7990a84c14a83e410262a8912cf478229b6f"
38
+ "commit": "bfde8e1d46e4becfa46148c293f74be9daabf1a3"
39
39
  }
@@ -5449,10 +5449,10 @@ export declare type PositionShorthand = PositionUnit | `${PositionUnit} ${Positi
5449
5449
  export declare type PositionType = 'absolute' | 'relative';
5450
5450
 
5451
5451
  /**
5452
- * unit value specified. i.e. 1 || '100%' || '1px'
5452
+ * unit value specified. i.e. 1 || '100%' || '1px' || '10vw'
5453
5453
  * @public
5454
5454
  */
5455
- export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}`;
5455
+ export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
5456
5456
 
5457
5457
  export declare enum ProcessMessageResultType {
5458
5458
  /**
@@ -6342,6 +6342,39 @@ export declare namespace Scale {
6342
6342
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Scale;
6343
6343
  }
6344
6344
 
6345
+ /**
6346
+ * context for applying a scale
6347
+ * @public
6348
+ */
6349
+ export declare type ScaleContext = {
6350
+ width: number;
6351
+ height: number;
6352
+ ratio: number;
6353
+ };
6354
+
6355
+ /**
6356
+ * Scales a font size depending on a context's width/height
6357
+ * @param {number} fontSize size of the font to scale
6358
+ * @param {ScaleUnit} [scaleUnit=0.39] the scaling unit (uses "width" as unit if a number is supplied)
6359
+ * @param {ScaleContext} [ctx=viewport] the context where to apply the scaling
6360
+ * @returns {number} the fontSize scaled
6361
+ * @see https://matthewjamestaylor.com/responsive-font-size#fluid
6362
+ * @public
6363
+ */
6364
+ export declare function scaleFontSize(fontSize: number, scaleUnit?: ScaleUnit, ctx?: ScaleContext | undefined): number;
6365
+
6366
+ /**
6367
+ * unit value specified. i.e. 10 || '10vw' || '10vh'
6368
+ * @public
6369
+ */
6370
+ export declare type ScaleUnit = `${number}${ScaleUnits}` | number;
6371
+
6372
+ /**
6373
+ * unit value type. i.e. 'vw' || 'vh'
6374
+ * @public
6375
+ */
6376
+ export declare type ScaleUnits = 'vw' | 'vh';
6377
+
6345
6378
  /**
6346
6379
  * @public
6347
6380
  */
@@ -6779,10 +6812,11 @@ export declare const UiDropdown: LastWriteWinElementSetComponentDefinition<PBUiD
6779
6812
  * @public
6780
6813
  * Dropdown Props
6781
6814
  */
6782
- export declare interface UiDropdownProps extends EntityPropTypes, Omit<Partial<PBUiDropdown>, 'textAlign' | 'font'> {
6815
+ export declare interface UiDropdownProps extends EntityPropTypes, Omit<Partial<PBUiDropdown>, 'textAlign' | 'font' | 'fontSize'> {
6783
6816
  onChange?(value: number): void;
6784
6817
  font?: UiFontType;
6785
6818
  textAlign?: TextAlignType;
6819
+ fontSize?: ScaleUnit;
6786
6820
  }
6787
6821
 
6788
6822
  /** @public */
@@ -6807,13 +6841,14 @@ export declare const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInpu
6807
6841
  /**
6808
6842
  * @public
6809
6843
  */
6810
- export declare interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign'> {
6844
+ export declare interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign' | 'fontSize'> {
6811
6845
  /** function to be called on value change */
6812
6846
  onChange?(value: string): void;
6813
6847
  /** function to be called on text field submit */
6814
6848
  onSubmit?(value: string): void;
6815
6849
  font?: UiFontType;
6816
6850
  textAlign?: TextAlignType;
6851
+ fontSize?: ScaleUnit;
6817
6852
  }
6818
6853
 
6819
6854
  /** @public */
@@ -6829,7 +6864,7 @@ export declare interface UiLabelProps {
6829
6864
  /** Color of the label. @defaultValue `{ r: 1, g: 1, b: 1, a: 1 }` */
6830
6865
  color?: PBColor4 | undefined;
6831
6866
  /** Label font size. @defaultValue 10 */
6832
- fontSize?: number | undefined;
6867
+ fontSize?: ScaleUnit | undefined;
6833
6868
  /** Label align position. @defaultValue 'middle-center' */
6834
6869
  textAlign?: TextAlignType | undefined;
6835
6870
  /** Label font type. @defaultValue 'sans-serif' */
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.40.1"
8
+ "packageVersion": "7.40.3"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.40.1",
4
+ "toolVersion": "7.40.3",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -55086,7 +55086,7 @@
55086
55086
  {
55087
55087
  "kind": "TypeAlias",
55088
55088
  "canonicalReference": "@dcl/playground-assets!PositionUnit:type",
55089
- "docComment": "/**\n * unit value specified. i.e. 1 || '100%' || '1px'\n *\n * @public\n */\n",
55089
+ "docComment": "/**\n * unit value specified. i.e. 1 || '100%' || '1px' || '10vw'\n *\n * @public\n */\n",
55090
55090
  "excerptTokens": [
55091
55091
  {
55092
55092
  "kind": "Content",
@@ -55094,7 +55094,12 @@
55094
55094
  },
55095
55095
  {
55096
55096
  "kind": "Content",
55097
- "text": "`${number}px` | `${number}%` | number | `${number}`"
55097
+ "text": "`${number}px` | `${number}%` | number | `${number}` | "
55098
+ },
55099
+ {
55100
+ "kind": "Reference",
55101
+ "text": "ScaleUnit",
55102
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type"
55098
55103
  },
55099
55104
  {
55100
55105
  "kind": "Content",
@@ -55106,7 +55111,7 @@
55106
55111
  "name": "PositionUnit",
55107
55112
  "typeTokenRange": {
55108
55113
  "startIndex": 1,
55109
- "endIndex": 2
55114
+ "endIndex": 3
55110
55115
  }
55111
55116
  },
55112
55117
  {
@@ -62455,6 +62460,176 @@
62455
62460
  }
62456
62461
  ]
62457
62462
  },
62463
+ {
62464
+ "kind": "TypeAlias",
62465
+ "canonicalReference": "@dcl/playground-assets!ScaleContext:type",
62466
+ "docComment": "/**\n * context for applying a scale\n *\n * @public\n */\n",
62467
+ "excerptTokens": [
62468
+ {
62469
+ "kind": "Content",
62470
+ "text": "export type ScaleContext = "
62471
+ },
62472
+ {
62473
+ "kind": "Content",
62474
+ "text": "{\n width: number;\n height: number;\n ratio: number;\n}"
62475
+ },
62476
+ {
62477
+ "kind": "Content",
62478
+ "text": ";"
62479
+ }
62480
+ ],
62481
+ "fileUrlPath": "../react-ecs/dist/components/types.d.ts",
62482
+ "releaseTag": "Public",
62483
+ "name": "ScaleContext",
62484
+ "typeTokenRange": {
62485
+ "startIndex": 1,
62486
+ "endIndex": 2
62487
+ }
62488
+ },
62489
+ {
62490
+ "kind": "Function",
62491
+ "canonicalReference": "@dcl/playground-assets!scaleFontSize:function(1)",
62492
+ "docComment": "/**\n * Scales a font size depending on a context's width/height\n *\n * @param fontSize - size of the font to scale\n *\n * @param scaleUnit - the scaling unit (uses \"width\" as unit if a number is supplied)\n *\n * @param ctx - the context where to apply the scaling\n *\n * @returns {number} the fontSize scaled\n *\n * @see\n *\n * https://matthewjamestaylor.com/responsive-font-size#fluid\n *\n * @public\n */\n",
62493
+ "excerptTokens": [
62494
+ {
62495
+ "kind": "Content",
62496
+ "text": "export declare function scaleFontSize(fontSize: "
62497
+ },
62498
+ {
62499
+ "kind": "Content",
62500
+ "text": "number"
62501
+ },
62502
+ {
62503
+ "kind": "Content",
62504
+ "text": ", scaleUnit?: "
62505
+ },
62506
+ {
62507
+ "kind": "Reference",
62508
+ "text": "ScaleUnit",
62509
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type"
62510
+ },
62511
+ {
62512
+ "kind": "Content",
62513
+ "text": ", ctx?: "
62514
+ },
62515
+ {
62516
+ "kind": "Reference",
62517
+ "text": "ScaleContext",
62518
+ "canonicalReference": "@dcl/playground-assets!ScaleContext:type"
62519
+ },
62520
+ {
62521
+ "kind": "Content",
62522
+ "text": " | undefined"
62523
+ },
62524
+ {
62525
+ "kind": "Content",
62526
+ "text": "): "
62527
+ },
62528
+ {
62529
+ "kind": "Content",
62530
+ "text": "number"
62531
+ },
62532
+ {
62533
+ "kind": "Content",
62534
+ "text": ";"
62535
+ }
62536
+ ],
62537
+ "fileUrlPath": "../react-ecs/dist/components/Label/utils.d.ts",
62538
+ "returnTypeTokenRange": {
62539
+ "startIndex": 8,
62540
+ "endIndex": 9
62541
+ },
62542
+ "releaseTag": "Public",
62543
+ "overloadIndex": 1,
62544
+ "parameters": [
62545
+ {
62546
+ "parameterName": "fontSize",
62547
+ "parameterTypeTokenRange": {
62548
+ "startIndex": 1,
62549
+ "endIndex": 2
62550
+ },
62551
+ "isOptional": false
62552
+ },
62553
+ {
62554
+ "parameterName": "scaleUnit",
62555
+ "parameterTypeTokenRange": {
62556
+ "startIndex": 3,
62557
+ "endIndex": 4
62558
+ },
62559
+ "isOptional": true
62560
+ },
62561
+ {
62562
+ "parameterName": "ctx",
62563
+ "parameterTypeTokenRange": {
62564
+ "startIndex": 5,
62565
+ "endIndex": 7
62566
+ },
62567
+ "isOptional": true
62568
+ }
62569
+ ],
62570
+ "name": "scaleFontSize"
62571
+ },
62572
+ {
62573
+ "kind": "TypeAlias",
62574
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type",
62575
+ "docComment": "/**\n * unit value specified. i.e. 10 || '10vw' || '10vh'\n *\n * @public\n */\n",
62576
+ "excerptTokens": [
62577
+ {
62578
+ "kind": "Content",
62579
+ "text": "export type ScaleUnit = "
62580
+ },
62581
+ {
62582
+ "kind": "Content",
62583
+ "text": "`${number}${"
62584
+ },
62585
+ {
62586
+ "kind": "Reference",
62587
+ "text": "ScaleUnits",
62588
+ "canonicalReference": "@dcl/playground-assets!ScaleUnits:type"
62589
+ },
62590
+ {
62591
+ "kind": "Content",
62592
+ "text": "}` | number"
62593
+ },
62594
+ {
62595
+ "kind": "Content",
62596
+ "text": ";"
62597
+ }
62598
+ ],
62599
+ "fileUrlPath": "../react-ecs/dist/components/types.d.ts",
62600
+ "releaseTag": "Public",
62601
+ "name": "ScaleUnit",
62602
+ "typeTokenRange": {
62603
+ "startIndex": 1,
62604
+ "endIndex": 4
62605
+ }
62606
+ },
62607
+ {
62608
+ "kind": "TypeAlias",
62609
+ "canonicalReference": "@dcl/playground-assets!ScaleUnits:type",
62610
+ "docComment": "/**\n * unit value type. i.e. 'vw' || 'vh'\n *\n * @public\n */\n",
62611
+ "excerptTokens": [
62612
+ {
62613
+ "kind": "Content",
62614
+ "text": "export type ScaleUnits = "
62615
+ },
62616
+ {
62617
+ "kind": "Content",
62618
+ "text": "'vw' | 'vh'"
62619
+ },
62620
+ {
62621
+ "kind": "Content",
62622
+ "text": ";"
62623
+ }
62624
+ ],
62625
+ "fileUrlPath": "../react-ecs/dist/components/types.d.ts",
62626
+ "releaseTag": "Public",
62627
+ "name": "ScaleUnits",
62628
+ "typeTokenRange": {
62629
+ "startIndex": 1,
62630
+ "endIndex": 2
62631
+ }
62632
+ },
62458
62633
  {
62459
62634
  "kind": "Namespace",
62460
62635
  "canonicalReference": "@dcl/playground-assets!Schemas:namespace",
@@ -66560,7 +66735,7 @@
66560
66735
  },
66561
66736
  {
66562
66737
  "kind": "Content",
66563
- "text": ">, 'textAlign' | 'font'>"
66738
+ "text": ">, 'textAlign' | 'font' | 'fontSize'>"
66564
66739
  },
66565
66740
  {
66566
66741
  "kind": "Content",
@@ -66600,6 +66775,34 @@
66600
66775
  "endIndex": 2
66601
66776
  }
66602
66777
  },
66778
+ {
66779
+ "kind": "PropertySignature",
66780
+ "canonicalReference": "@dcl/playground-assets!UiDropdownProps#fontSize:member",
66781
+ "docComment": "",
66782
+ "excerptTokens": [
66783
+ {
66784
+ "kind": "Content",
66785
+ "text": "fontSize?: "
66786
+ },
66787
+ {
66788
+ "kind": "Reference",
66789
+ "text": "ScaleUnit",
66790
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type"
66791
+ },
66792
+ {
66793
+ "kind": "Content",
66794
+ "text": ";"
66795
+ }
66796
+ ],
66797
+ "isReadonly": false,
66798
+ "isOptional": true,
66799
+ "releaseTag": "Public",
66800
+ "name": "fontSize",
66801
+ "propertyTypeTokenRange": {
66802
+ "startIndex": 1,
66803
+ "endIndex": 2
66804
+ }
66805
+ },
66603
66806
  {
66604
66807
  "kind": "MethodSignature",
66605
66808
  "canonicalReference": "@dcl/playground-assets!UiDropdownProps#onChange:member(1)",
@@ -66870,7 +67073,7 @@
66870
67073
  },
66871
67074
  {
66872
67075
  "kind": "Content",
66873
- "text": ", 'font' | 'textAlign'>"
67076
+ "text": ", 'font' | 'textAlign' | 'fontSize'>"
66874
67077
  },
66875
67078
  {
66876
67079
  "kind": "Content",
@@ -66910,6 +67113,34 @@
66910
67113
  "endIndex": 2
66911
67114
  }
66912
67115
  },
67116
+ {
67117
+ "kind": "PropertySignature",
67118
+ "canonicalReference": "@dcl/playground-assets!UiInputProps#fontSize:member",
67119
+ "docComment": "",
67120
+ "excerptTokens": [
67121
+ {
67122
+ "kind": "Content",
67123
+ "text": "fontSize?: "
67124
+ },
67125
+ {
67126
+ "kind": "Reference",
67127
+ "text": "ScaleUnit",
67128
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type"
67129
+ },
67130
+ {
67131
+ "kind": "Content",
67132
+ "text": ";"
67133
+ }
67134
+ ],
67135
+ "isReadonly": false,
67136
+ "isOptional": true,
67137
+ "releaseTag": "Public",
67138
+ "name": "fontSize",
67139
+ "propertyTypeTokenRange": {
67140
+ "startIndex": 1,
67141
+ "endIndex": 2
67142
+ }
67143
+ },
66913
67144
  {
66914
67145
  "kind": "MethodSignature",
66915
67146
  "canonicalReference": "@dcl/playground-assets!UiInputProps#onChange:member(1)",
@@ -67161,9 +67392,14 @@
67161
67392
  "kind": "Content",
67162
67393
  "text": "fontSize?: "
67163
67394
  },
67395
+ {
67396
+ "kind": "Reference",
67397
+ "text": "ScaleUnit",
67398
+ "canonicalReference": "@dcl/playground-assets!ScaleUnit:type"
67399
+ },
67164
67400
  {
67165
67401
  "kind": "Content",
67166
- "text": "number | undefined"
67402
+ "text": " | undefined"
67167
67403
  },
67168
67404
  {
67169
67405
  "kind": "Content",
@@ -67176,7 +67412,7 @@
67176
67412
  "name": "fontSize",
67177
67413
  "propertyTypeTokenRange": {
67178
67414
  "startIndex": 1,
67179
- "endIndex": 2
67415
+ "endIndex": 3
67180
67416
  }
67181
67417
  },
67182
67418
  {
@@ -3335,7 +3335,7 @@ export type PositionShorthand = PositionUnit | `${PositionUnit} ${PositionUnit}`
3335
3335
  export type PositionType = 'absolute' | 'relative';
3336
3336
 
3337
3337
  // @public
3338
- export type PositionUnit = `${number}px` | `${number}%` | number | `${number}`;
3338
+ export type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
3339
3339
 
3340
3340
  // Warning: (ae-missing-release-tag) "ProcessMessageResultType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
3341
3341
  //
@@ -3704,6 +3704,33 @@ export namespace Scale {
3704
3704
  export function encode(message: Scale, writer?: _m0.Writer): _m0.Writer;
3705
3705
  }
3706
3706
 
3707
+ // @public
3708
+ export type ScaleContext = {
3709
+ width: number;
3710
+ height: number;
3711
+ ratio: number;
3712
+ };
3713
+
3714
+ // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
3715
+ // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
3716
+ // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
3717
+ // Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
3718
+ // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
3719
+ // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
3720
+ // Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
3721
+ // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
3722
+ // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
3723
+ // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
3724
+ //
3725
+ // @public
3726
+ export function scaleFontSize(fontSize: number, scaleUnit?: ScaleUnit, ctx?: ScaleContext | undefined): number;
3727
+
3728
+ // @public
3729
+ export type ScaleUnit = `${number}${ScaleUnits}` | number;
3730
+
3731
+ // @public
3732
+ export type ScaleUnits = 'vw' | 'vh';
3733
+
3707
3734
  // @public (undocumented)
3708
3735
  export namespace Schemas {
3709
3736
  // (undocumented)
@@ -4062,10 +4089,12 @@ export type UiComponent = () => ReactEcs.JSX.Element;
4062
4089
  export const UiDropdown: LastWriteWinElementSetComponentDefinition<PBUiDropdown>;
4063
4090
 
4064
4091
  // @public
4065
- export interface UiDropdownProps extends EntityPropTypes, Omit<Partial<PBUiDropdown>, 'textAlign' | 'font'> {
4092
+ export interface UiDropdownProps extends EntityPropTypes, Omit<Partial<PBUiDropdown>, 'textAlign' | 'font' | 'fontSize'> {
4066
4093
  // (undocumented)
4067
4094
  font?: UiFontType;
4068
4095
  // (undocumented)
4096
+ fontSize?: ScaleUnit;
4097
+ // (undocumented)
4069
4098
  onChange?(value: number): void;
4070
4099
  // (undocumented)
4071
4100
  textAlign?: TextAlignType;
@@ -4088,9 +4117,11 @@ export type UiFontType = 'sans-serif' | 'serif' | 'monospace';
4088
4117
  export const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInput>;
4089
4118
 
4090
4119
  // @public (undocumented)
4091
- export interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign'> {
4120
+ export interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign' | 'fontSize'> {
4092
4121
  // (undocumented)
4093
4122
  font?: UiFontType;
4123
+ // (undocumented)
4124
+ fontSize?: ScaleUnit;
4094
4125
  onChange?(value: string): void;
4095
4126
  onSubmit?(value: string): void;
4096
4127
  // (undocumented)
@@ -4104,7 +4135,7 @@ export const UiInputResult: LastWriteWinElementSetComponentDefinition<PBUiInputR
4104
4135
  export interface UiLabelProps {
4105
4136
  color?: PBColor4 | undefined;
4106
4137
  font?: UiFontType | undefined;
4107
- fontSize?: number | undefined;
4138
+ fontSize?: ScaleUnit | undefined;
4108
4139
  textAlign?: TextAlignType | undefined;
4109
4140
  value: string;
4110
4141
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@dcl/playground-assets",
3
3
  "description": "",
4
- "version": "7.4.3-7935604720.commit-e16c799",
4
+ "version": "7.4.3-7976826769.commit-bfde8e1",
5
5
  "author": "Decentraland",
6
6
  "dependencies": {
7
- "@dcl/js-runtime": "7.4.3-7935604720.commit-e16c799",
8
- "@dcl/sdk": "7.4.3-7935604720.commit-e16c799"
7
+ "@dcl/js-runtime": "7.4.3-7976826769.commit-bfde8e1",
8
+ "@dcl/sdk": "7.4.3-7976826769.commit-bfde8e1"
9
9
  },
10
10
  "devDependencies": {
11
11
  "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
32
32
  },
33
33
  "types": "./dist/index.d.ts",
34
34
  "typings": "./dist/index.d.ts",
35
- "commit": "e16c7990a84c14a83e410262a8912cf478229b6f"
35
+ "commit": "bfde8e1d46e4becfa46148c293f74be9daabf1a3"
36
36
  }