npm - @atlaskit/forge-react-types - Versions diffs - 0.1.1 - Mend

@atlaskit/forge-react-types 0.1.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.

Files changed (332) hide show

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,11 @@
+# @atlaskit/forge-react-types
+## 0.1.1
+### Patch Changes
+- [#72257](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/72257) [`08729b392d3b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/08729b392d3b) - Export all UI Kit 2 code generated component types.
+## 0.1.0
+### Minor Changes

package/LICENSE.md ADDED Viewed

@@ -0,0 +1,13 @@
+Copyright 2023 Atlassian Pty Ltd
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md ADDED Viewed

@@ -0,0 +1,31 @@
+# Forge React Types
+This package exposes a public npm package (`@atlaskit/forge-react-types`) that contains
+all necessary types for UIKit2 codegen components.
+The types are code generated from the `@atlassian/forge-ui` package and are
+guaranteed to be in sync with the source component implementation in the `@atlassian/forge-ui` package.
+Additionally, the package syncs ADS component related dependencies from `@atlassian/forge-ui` package, to ensure that the types are in sync with the source component implementation. This allows @forge/react package to
+have the consistent ADS component dependencies to the AFM platform, instead
+of being bounded by other dependencies in the Forge mono-repo.
+## Usage
+To generate / update all types, run the following command:
+```bash
+yarn workspace @atlaskit/forge-react-types codegen
+```
+During development, the codegen command can be run for a specific component:
+```bash
+yarn workspace @atlaskit/forge-react-types <component-name>
+```
+e.g.
+```bash
+yarn workspace @atlaskit/forge-react-types ButtonProps
+```

package/dist/cjs/components/__generated__/BadgeProps.js ADDED Viewed

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/components/__generated__/BleedProps.js ADDED Viewed

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/components/__generated__/BoxProps.js ADDED Viewed

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Extract component prop types from UIKit 2 components - BoxProps
+ *
+ * @codegen <<SignedSource::f944bf8c402e5ee3db834cccae245e97>>
+ * @codegenCommand yarn workspace @atlaskit/forge-react-types codegen
+ * @codegenDependency ../../../../forge-ui/src/components/UIKit2-codegen/box/__generated__/index.partial.tsx <<SignedSource::569858ee5138d1211836ec105de370c8>>
+ */
+/* eslint-disable @atlaskit/design-system/ensure-design-token-usage/preview */
+/**
+ *
+ * @param supportedXCSSProps - the list of css props to be supported for the intended component.
+ *    If not provided, all the props will be supported. The props could be either standard css props
+ *    or design token based props. If the prop is a design token based prop, the value of the prop
+ *    will be validated against the design tokens map to ensure the value is a valid design token string.
+ * @returns a function that takes a style object and returns a style object with only the supported props
+ *    as specified in the supportedXCSSProps list. The props that are not supported will be removed from the
+ *    returned style object and a warning will be logged in the console.
+ */
+var xcssValidator = makeXCSSValidator({
+  // color related props
+  color: true,
+  boxShadow: true,
+  opacity: true,
+  backgroundColor: true,
+  borderColor: true,
+  borderBlockColor: true,
+  borderBlockEndColor: true,
+  borderBlockStartColor: true,
+  borderBottomColor: true,
+  borderInlineColor: true,
+  borderInlineEndColor: true,
+  borderInlineStartColor: true,
+  borderLeftColor: true,
+  borderRightColor: true,
+  borderTopColor: true,
+  // layout and space related props
+  width: {
+    allowCSS: true
+  },
+  height: {
+    allowCSS: true
+  },
+  minWidth: {
+    allowCSS: true
+  },
+  maxWidth: {
+    allowCSS: true
+  },
+  minHeight: {
+    allowCSS: true
+  },
+  maxHeight: {
+    allowCSS: true
+  },
+  margin: true,
+  marginBlock: true,
+  marginBlockEnd: true,
+  marginBlockStart: true,
+  marginBottom: true,
+  marginInline: true,
+  marginInlineEnd: true,
+  marginInlineStart: true,
+  marginLeft: true,
+  marginRight: true,
+  marginTop: true,
+  padding: true,
+  paddingBlock: true,
+  paddingBlockEnd: true,
+  paddingBlockStart: true,
+  paddingBottom: true,
+  paddingInline: true,
+  paddingInlineEnd: true,
+  paddingInlineStart: true,
+  paddingLeft: true,
+  paddingRight: true,
+  paddingTop: true,
+  // other box related props
+  borderRadius: true,
+  borderBottomLeftRadius: true,
+  borderBottomRightRadius: true,
+  borderTopLeftRadius: true,
+  borderTopRightRadius: true,
+  borderEndEndRadius: true,
+  borderEndStartRadius: true,
+  borderStartEndRadius: true,
+  borderStartStartRadius: true,
+  borderWidth: true,
+  borderBlockWidth: true,
+  borderBlockEndWidth: true,
+  borderBlockStartWidth: true,
+  borderBottomWidth: true,
+  borderInlineWidth: true,
+  borderInlineEndWidth: true,
+  borderInlineStartWidth: true,
+  borderLeftWidth: true,
+  borderRightWidth: true,
+  borderTopWidth: true,
+  // other props not in tokens based props
+  borderTopStyle: {
+    supportedValues: ['dotted', 'dashed', 'solid', 'none', 'hidden']
+  },
+  borderBottomStyle: {
+    supportedValues: ['dotted', 'dashed', 'solid', 'none', 'hidden']
+  },
+  borderRightStyle: {
+    supportedValues: ['dotted', 'dashed', 'solid', 'none', 'hidden']
+  },
+  borderLeftStyle: {
+    supportedValues: ['dotted', 'dashed', 'solid', 'none', 'hidden']
+  },
+  borderStyle: {
+    supportedValues: ['dotted', 'dashed', 'solid', 'none', 'hidden']
+  },
+  position: {
+    supportedValues: ['relative', 'static']
+  }
+});