@commercetools-uikit/constraints
Advanced tools
Comparing version 0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6 to 0.0.0-preview-FCT-1187-20241021190428
{ | ||
"name": "@commercetools-uikit/constraints", | ||
"version": "0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6", | ||
"description": "", | ||
"main": "dist/constraints.cjs.js", | ||
"module": "dist/constraints.esm.js", | ||
"private": false, | ||
"description": "Constraints are container elements with a configurable constraint size, like width or height.", | ||
"version": "0.0.0-preview-FCT-1187-20241021190428", | ||
"bugs": "https://github.com/commercetools/ui-kit/issues", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/commercetools/ui-kit.git", | ||
"directory": "packages/components/constraints" | ||
}, | ||
"homepage": "https://uikit.commercetools.com", | ||
"keywords": [ | ||
"javascript", | ||
"typescript", | ||
"design-system", | ||
"react", | ||
"uikit" | ||
], | ||
"license": "MIT", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"scripts": { | ||
"prepare": "../../../scripts/version.js replace", | ||
"prebuild": "rimraf dist", | ||
"build": "cross-env NODE_ENV=production rollup -c ../../../rollup.config.js -i ./src/index.js" | ||
}, | ||
"sideEffects": false, | ||
"main": "dist/commercetools-uikit-constraints.cjs.js", | ||
"module": "dist/commercetools-uikit-constraints.esm.js", | ||
"files": [ | ||
"dist" | ||
], | ||
"sideEffects": false, | ||
"license": "MIT", | ||
"dependencies": { | ||
"@commercetools-uikit/design-system": "0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6", | ||
"@commercetools-uikit/utils": "0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6", | ||
"@emotion/core": "10.0.28", | ||
"@emotion/styled": "10.0.27", | ||
"prop-types": "15.7.2" | ||
"@babel/runtime": "^7.20.13", | ||
"@babel/runtime-corejs3": "^7.20.13", | ||
"@commercetools-uikit/design-system": "0.0.0-preview-FCT-1187-20241021190428", | ||
"@commercetools-uikit/utils": "0.0.0-preview-FCT-1187-20241021190428", | ||
"@emotion/react": "^11.10.5", | ||
"@emotion/styled": "^11.10.5", | ||
"prop-types": "15.8.1" | ||
}, | ||
"devDependencies": { | ||
"react": "17.0.2" | ||
}, | ||
"peerDependencies": { | ||
"react": ">= 16.8.0" | ||
"react": "17.x" | ||
}, | ||
"gitHead": "02415af0908240886920a1c585c6a984a621925a" | ||
"readme": { | ||
"componentPaths": [ | ||
"./src/horizontal/horizontal.tsx" | ||
] | ||
} | ||
} |
@@ -1,3 +0,30 @@ | ||
# Constraint | ||
<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. --> | ||
<!-- This file is created by the `yarn generate-readme` script. --> | ||
# Constraints | ||
## Description | ||
Constraints are container elements with a configurable constraint size, like width or height. | ||
## Installation | ||
``` | ||
yarn add @commercetools-uikit/constraints | ||
``` | ||
``` | ||
npm --save install @commercetools-uikit/constraints | ||
``` | ||
Additionally install the peer dependencies (if not present) | ||
``` | ||
yarn add react | ||
``` | ||
``` | ||
npm --save install react | ||
``` | ||
## Usage | ||
@@ -8,23 +35,18 @@ | ||
<Constraints.Horizontal constraint="m"> | ||
<DatePicker /> | ||
<Constraints.Horizontal max={7}> | ||
<p> | ||
Lorem ipsum dolor sit amet, id labitur perpetua vix. An graece iisque | ||
corpora sit, erant nihil signiferumque et pro, cu ius minim altera | ||
temporibus. | ||
</p> | ||
</Constraints.Horizontal>; | ||
``` | ||
## Properties | ||
## Horizontal | ||
| Props | Type | Required | Values | Default | | ||
| ------------ | ---------------- | :------: | ------------------------------------ | ------- | | ||
| `constraint` | `String` | - | `'scale', 'xs', 's', 'm', 'l', 'xl'` | `scale` | | ||
| `children` | `PropTypes.node` | ✅ | - | - | | ||
### Properties | ||
## Scales | ||
| Scale | Pixel | | ||
| :---- | :------ | | ||
| scale | `100%` | | ||
| xs | `50px` | | ||
| s | `132px` | | ||
| m | `355px` | | ||
| l | `496px` | | ||
| xl | `768px` | | ||
| Props | Type | Required | Default | Description | | ||
| ---------- | ----------------------------------------------------------------------------------------------------------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `max` | `union`<br/>Possible values:<br/>`, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'` | | | The value of the constraint. See equivalent pixel values [here](https://uikit.commercetools.com/?path=/story/basics-tokens--all-tokens). | | ||
| `children` | `ReactNode` | ✅ | | | |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
43606
13
349
1
52
8
1
19
1
+ Added@babel/runtime@^7.20.13
+ Added@emotion/react@^11.10.5
+ Added@babel/generator@7.26.5(transitive)
+ Added@babel/parser@7.26.7(transitive)
+ Added@babel/runtime-corejs3@7.26.7(transitive)
+ Added@babel/template@7.25.9(transitive)
+ Added@babel/traverse@7.26.7(transitive)
+ Added@babel/types@7.26.7(transitive)
+ Added@commercetools-uikit/design-system@0.0.0-preview-FCT-1187-20241021190428(transitive)
+ Added@commercetools-uikit/hooks@0.0.0-preview-FCT-1187-20241021190428(transitive)
+ Added@commercetools-uikit/utils@0.0.0-preview-FCT-1187-20241021190428(transitive)
+ Added@emotion/babel-plugin@11.13.5(transitive)
+ Added@emotion/cache@11.14.0(transitive)
+ Added@emotion/hash@0.9.2(transitive)
+ Added@emotion/is-prop-valid@1.3.1(transitive)
+ Added@emotion/memoize@0.9.0(transitive)
+ Added@emotion/react@11.14.0(transitive)
+ Added@emotion/serialize@1.3.3(transitive)
+ Added@emotion/sheet@1.4.0(transitive)
+ Added@emotion/styled@11.14.0(transitive)
+ Added@emotion/unitless@0.10.0(transitive)
+ Added@emotion/use-insertion-effect-with-fallbacks@1.2.0(transitive)
+ Added@emotion/utils@1.4.2(transitive)
+ Added@emotion/weak-memoize@0.4.0(transitive)
+ Added@types/raf-schd@4.0.3(transitive)
+ Addedbabel-plugin-macros@3.1.0(transitive)
+ Addedcore-js-pure@3.40.0(transitive)
+ Addedcosmiconfig@7.1.0(transitive)
+ Addedcsstype@3.1.3(transitive)
+ Addedescape-string-regexp@4.0.0(transitive)
+ Addedhoist-non-react-statics@3.3.2(transitive)
+ Addedlodash@4.17.21(transitive)
+ Addedprop-types@15.8.1(transitive)
+ Addedraf-schd@4.0.3(transitive)
+ Addedreact@17.0.2(transitive)
+ Addedreact-dom@17.0.2(transitive)
+ Addedscheduler@0.20.2(transitive)
+ Addedstylis@4.2.0(transitive)
- Removed@emotion/core@10.0.28
- Removed@babel/generator@7.26.8(transitive)
- Removed@babel/parser@7.26.8(transitive)
- Removed@babel/template@7.26.8(transitive)
- Removed@babel/traverse@7.26.8(transitive)
- Removed@babel/types@7.26.8(transitive)
- Removed@commercetools-uikit/design-system@0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6(transitive)
- Removed@commercetools-uikit/utils@0.0.0-canary-f592e685bb1af2ae3cc09fae010abe25e130b5e6(transitive)
- Removed@emotion/cache@10.0.29(transitive)
- Removed@emotion/core@10.0.28(transitive)
- Removed@emotion/css@10.0.27(transitive)
- Removed@emotion/hash@0.8.0(transitive)
- Removed@emotion/is-prop-valid@0.8.8(transitive)
- Removed@emotion/memoize@0.7.4(transitive)
- Removed@emotion/serialize@0.11.16(transitive)
- Removed@emotion/sheet@0.9.4(transitive)
- Removed@emotion/styled@10.0.27(transitive)
- Removed@emotion/styled-base@10.3.0(transitive)
- Removed@emotion/stylis@0.8.5(transitive)
- Removed@emotion/unitless@0.7.5(transitive)
- Removed@emotion/utils@0.11.3(transitive)
- Removed@emotion/weak-memoize@0.2.5(transitive)
- Removedbabel-plugin-emotion@10.2.2(transitive)
- Removedbabel-plugin-macros@2.8.0(transitive)
- Removedbabel-plugin-syntax-jsx@6.18.0(transitive)
- Removedcosmiconfig@6.0.0(transitive)
- Removedcsstype@2.6.21(transitive)
- Removedescape-string-regexp@1.0.5(transitive)
- Removedprop-types@15.7.2(transitive)
- Removedreact@19.0.0(transitive)
- Removedwarning@4.0.3(transitive)
Updated@commercetools-uikit/design-system@0.0.0-preview-FCT-1187-20241021190428
Updated@commercetools-uikit/utils@0.0.0-preview-FCT-1187-20241021190428
Updated@emotion/styled@^11.10.5
Updatedprop-types@15.8.1