UNPKG

@commercetools-uikit/constraints

Version:

Constraints are container elements with a configurable constraint size, like width or height.

uikit.commercetools.com

commercetools/ui-kit

52 lines (36 loc) • 2 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. --> <!-- This file is created by the `pnpm generate-readme` script. --> # Constraints ## Description Constraints are container elements with a configurable constraint size, like width or height. ## Installation ``` pnpm add @commercetools-uikit/constraints ``` ``` npm --save install @commercetools-uikit/constraints ``` Additionally install the peer dependencies (if not present) ``` pnpm add react ``` ``` npm --save install react ``` ## Usage ```jsx import Constraints from '@commercetools-uikit/constraints'; <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>; ``` ## Horizontal ### Properties | 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` | ✅ | | |