@carbon/layout 10.1.1 β 10.2.0
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/LICENSE +2 -2
- package/README.md +17 -19
- package/docs/sass.md +2 -1
- package/package.json +4 -4
- package/scss/index.scss +8 -0
package/LICENSE
CHANGED
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
APPENDIX: How to apply the Apache License to your work.
|
|
179
179
|
|
|
180
180
|
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
182
|
replaced with your own identifying information. (Don't include
|
|
183
183
|
the brackets!) The text should be enclosed in the appropriate
|
|
184
184
|
comment syntax for the file format. We also recommend that a
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright 2015 IBM Corp.
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
# @carbon/layout
|
|
2
2
|
|
|
3
|
-
> Layout helpers for digital and software products using the Carbon
|
|
4
|
-
>
|
|
3
|
+
> Layout helpers for digital and software products using the Carbon Design
|
|
4
|
+
> System
|
|
5
5
|
|
|
6
6
|
## Getting started
|
|
7
7
|
|
|
8
|
-
To install `@carbon/layout` in your project, you will need to run the
|
|
9
|
-
|
|
8
|
+
To install `@carbon/layout` in your project, you will need to run the following
|
|
9
|
+
command using [npm](https://www.npmjs.com/):
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
npm install -S @carbon/layout
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
If you prefer [Yarn](https://yarnpkg.com/en/), use the following
|
|
16
|
-
|
|
15
|
+
If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
|
|
16
|
+
instead:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
19
|
yarn add @carbon/layout
|
|
@@ -22,8 +22,8 @@ yarn add @carbon/layout
|
|
|
22
22
|
## Usage
|
|
23
23
|
|
|
24
24
|
`@carbon/layout` provides a couple of useful utilities alongside the
|
|
25
|
-
specification for the grid system for the IBM Design Language. This
|
|
26
|
-
|
|
25
|
+
specification for the grid system for the IBM Design Language. This package
|
|
26
|
+
includes:
|
|
27
27
|
|
|
28
28
|
| Feature | Description |
|
|
29
29
|
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -33,14 +33,13 @@ package includes:
|
|
|
33
33
|
| Mini unit | Helpers for working in multiples of the mini-unit |
|
|
34
34
|
| Spacing | Provides a spacing scale and helper for using steps in the scale |
|
|
35
35
|
|
|
36
|
-
One important thing to remember is that `@carbon/layout` is not
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
package.
|
|
36
|
+
One important thing to remember is that `@carbon/layout` is not responsible for
|
|
37
|
+
the grid itself. If you are looking for a grid implementation to use, definitely
|
|
38
|
+
checkout the [`@carbon/grid`](../grid) package.
|
|
40
39
|
|
|
41
|
-
`@carbon/layout` provides the above features in both Sass and
|
|
42
|
-
|
|
43
|
-
|
|
40
|
+
`@carbon/layout` provides the above features in both Sass and JavaScript. If
|
|
41
|
+
you're looking for support in a different language, feel free to file an issue
|
|
42
|
+
proposing the new addition!
|
|
44
43
|
|
|
45
44
|
## π API Documentation
|
|
46
45
|
|
|
@@ -50,10 +49,9 @@ If you're looking for `@carbon/layout` API documentation, check out:
|
|
|
50
49
|
|
|
51
50
|
## π Contributing
|
|
52
51
|
|
|
53
|
-
We're always looking for contributors to help us fix bugs, build new
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
! π
|
|
52
|
+
We're always looking for contributors to help us fix bugs, build new features,
|
|
53
|
+
or help us improve the project documentation. If you're interested, definitely
|
|
54
|
+
check out our [Contributing Guide](/.github/CONTRIBUTING.md) ! π
|
|
57
55
|
|
|
58
56
|
## π License
|
|
59
57
|
|
package/docs/sass.md
CHANGED
|
@@ -291,7 +291,8 @@ Returns the largest breakpoint name
|
|
|
291
291
|
|
|
292
292
|
### β
carbon--breakpoint-infix [function]
|
|
293
293
|
|
|
294
|
-
Get the infix for a given breakpoint in a list of breakpoints. Usesful for
|
|
294
|
+
Get the infix for a given breakpoint in a list of breakpoints. Usesful for
|
|
295
|
+
generate the size part in a selector, for example: `.prefix--col-sm-2`.
|
|
295
296
|
|
|
296
297
|
<details>
|
|
297
298
|
<summary>Source code</summary>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@carbon/layout",
|
|
3
3
|
"description": "Layout helpers for digital and software products using the Carbon Design System",
|
|
4
|
-
"version": "10.
|
|
4
|
+
"version": "10.2.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"module": "es/index.js",
|
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
"access": "public"
|
|
20
20
|
},
|
|
21
21
|
"scripts": {
|
|
22
|
-
"build": "yarn clean && bundler bundle src/index.js --name CarbonLayout && bundler sassdoc 'scss'",
|
|
22
|
+
"build": "yarn clean && bundler bundle src/index.js --name CarbonLayout && bundler sassdoc 'scss/*.scss'",
|
|
23
23
|
"clean": "rimraf es lib umd"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@carbon/bundler": "10.
|
|
26
|
+
"@carbon/bundler": "10.2.0",
|
|
27
27
|
"rimraf": "^2.6.2"
|
|
28
28
|
},
|
|
29
29
|
"eyeglass": {
|
|
@@ -32,5 +32,5 @@
|
|
|
32
32
|
"sassDir": "scss",
|
|
33
33
|
"needs": "^1.3.0"
|
|
34
34
|
},
|
|
35
|
-
"gitHead": "
|
|
35
|
+
"gitHead": "e71825a0cf44f6f41fee7d2b0dd9c57d7bda126a"
|
|
36
36
|
}
|