@atlaskit/forge-react-types 0.48.0 → 0.49.1
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.
- package/CHANGELOG.md +18 -0
- package/dist/cjs/components/__generated__/BoxProps.codegen.js +2 -2
- package/dist/es2019/components/__generated__/BoxProps.codegen.js +2 -2
- package/dist/esm/components/__generated__/BoxProps.codegen.js +2 -2
- package/dist/types/components/__generated__/BoxProps.codegen.d.ts +24 -22
- package/dist/types/components/__generated__/IconProps.codegen.d.ts +14 -14
- package/dist/types-ts4.5/components/__generated__/BoxProps.codegen.d.ts +24 -22
- package/dist/types-ts4.5/components/__generated__/IconProps.codegen.d.ts +14 -14
- package/package.json +7 -7
- package/scripts/codegen/codeGenerator.ts +3 -3
- package/scripts/codegen/componentPropTypes.ts +1 -1
- package/scripts/typechecker.ts +6 -1
- package/src/components/__generated__/BoxProps.codegen.tsx +26 -24
- package/src/components/__generated__/IconProps.codegen.tsx +670 -15
|
@@ -3,14 +3,14 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Extract component prop types from UIKit 2 components - BoxProps
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::2576658a875b738553fdb3ccfa41acd1>>
|
|
7
7
|
* @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
|
|
8
|
-
* @codegenDependency ../../../../forge-ui/src/components/UIKit/box/
|
|
8
|
+
* @codegenDependency ../../../../forge-ui/src/components/UIKit/box/index.tsx <<SignedSource::6b375bb57ecf19919f9e1b65e899fd96>>
|
|
9
9
|
*/
|
|
10
10
|
/* eslint-disable @atlaskit/design-system/ensure-design-token-usage/preview */
|
|
11
11
|
|
|
12
12
|
import React from 'react';
|
|
13
|
-
import { Box as PlatformBox } from '@atlaskit/primitives';
|
|
13
|
+
import type { Box as PlatformBox } from '@atlaskit/primitives';
|
|
14
14
|
|
|
15
15
|
import type * as CSS from 'csstype';
|
|
16
16
|
import type { MediaQuery } from '@atlaskit/primitives';
|
|
@@ -207,6 +207,22 @@ type XCSSProp = ReturnType<typeof xcssValidator>;
|
|
|
207
207
|
type PlatformBoxProps = React.ComponentProps<typeof PlatformBox>;
|
|
208
208
|
|
|
209
209
|
export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
|
|
210
|
+
/**
|
|
211
|
+
* A token alias for background color. See: [Design tokens](https://atlassian.design/components/tokens/all-tokens)
|
|
212
|
+
* for a list of available colors.
|
|
213
|
+
*
|
|
214
|
+
* When the background color is set to a surface token, the current surface CSS variable
|
|
215
|
+
* will also be set to this value in the `Box` styles.
|
|
216
|
+
*
|
|
217
|
+
* @type [Background color tokens](https://atlassian.design/components/tokens/all-tokens#color-background)
|
|
218
|
+
*/
|
|
219
|
+
backgroundColor?: PlatformBoxProps['backgroundColor'];
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* @type ForgeComponent
|
|
223
|
+
*/
|
|
224
|
+
children?: PlatformBoxProps['children'];
|
|
225
|
+
|
|
210
226
|
/**
|
|
211
227
|
* A shorthand for `paddingBlock` and `paddingInline` together.
|
|
212
228
|
*
|
|
@@ -222,18 +238,18 @@ export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
|
|
|
222
238
|
paddingBlock?: PlatformBoxProps['paddingBlock'];
|
|
223
239
|
|
|
224
240
|
/**
|
|
225
|
-
* The logical block
|
|
241
|
+
* The logical block end padding of an element.
|
|
226
242
|
*
|
|
227
243
|
* @type [Space tokens](https://atlassian.design/components/tokens/all-tokens#space)
|
|
228
244
|
*/
|
|
229
|
-
|
|
245
|
+
paddingBlockEnd?: PlatformBoxProps['paddingBlockEnd'];
|
|
230
246
|
|
|
231
247
|
/**
|
|
232
|
-
* The logical block
|
|
248
|
+
* The logical block start padding of an element.
|
|
233
249
|
*
|
|
234
250
|
* @type [Space tokens](https://atlassian.design/components/tokens/all-tokens#space)
|
|
235
251
|
*/
|
|
236
|
-
|
|
252
|
+
paddingBlockStart?: PlatformBoxProps['paddingBlockStart'];
|
|
237
253
|
|
|
238
254
|
/**
|
|
239
255
|
* The logical inline start and end padding of an element.
|
|
@@ -257,15 +273,11 @@ export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
|
|
|
257
273
|
paddingInlineStart?: PlatformBoxProps['paddingInlineStart'];
|
|
258
274
|
|
|
259
275
|
/**
|
|
260
|
-
*
|
|
261
|
-
* for a list of available colors.
|
|
276
|
+
* Accessible role.
|
|
262
277
|
*
|
|
263
|
-
*
|
|
264
|
-
* will also be set to this value in the `Box` styles.
|
|
265
|
-
*
|
|
266
|
-
* @type [Background color tokens](https://atlassian.design/components/tokens/all-tokens#color-background)
|
|
278
|
+
* @type string
|
|
267
279
|
*/
|
|
268
|
-
|
|
280
|
+
role?: PlatformBoxProps['role'];
|
|
269
281
|
|
|
270
282
|
/**
|
|
271
283
|
* Apply a subset of permitted styles, powered by Atlassian Design System tokens.
|
|
@@ -274,16 +286,6 @@ export type BoxProps = Pick<PlatformBoxProps, 'children' | 'ref' | 'testId'> & {
|
|
|
274
286
|
* @type XCSSProp
|
|
275
287
|
*/
|
|
276
288
|
xcss?: XCSSProp;
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* @type string
|
|
280
|
-
*/
|
|
281
|
-
role?: PlatformBoxProps['role'];
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* @type ForgeComponent
|
|
285
|
-
*/
|
|
286
|
-
children?: PlatformBoxProps['children'];
|
|
287
289
|
};
|
|
288
290
|
|
|
289
291
|
/**
|