@octaviaflow/elements 1.0.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/README.md +91 -0
- package/es/index.js +5 -0
- package/index.scss +13 -0
- package/lib/index.js +646 -0
- package/package.json +53 -0
- package/src/__tests__/PublicAPI-test.js +15 -0
- package/src/__tests__/PublicAPI.test.js +14 -0
- package/src/__tests__/__snapshots__/PublicAPI-test.js.snap +384 -0
- package/src/__tests__/__snapshots__/PublicAPI.test.js.snap +384 -0
- package/src/index.js +176 -0
- package/telemetry.yml +17 -0
- package/umd/index.js +644 -0
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# @octaviaflow/elements
|
|
2
|
+
|
|
3
|
+
> A collection of design elements in code for the IBM Design Language
|
|
4
|
+
|
|
5
|
+
## Getting started
|
|
6
|
+
|
|
7
|
+
To install `@octaviaflow/elements` in your project, you will need to run the
|
|
8
|
+
following command using [npm](https://www.npmjs.com/):
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -S @octaviaflow/elements
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
|
|
15
|
+
instead:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
yarn add @octaviaflow/elements
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
`@octaviaflow/elements` includes all of the other elements packages in the project
|
|
24
|
+
and can be useful instead of installing each package individually. This package
|
|
25
|
+
offers support for both the JavaScript exports from these packages, in addition
|
|
26
|
+
to Sass support.
|
|
27
|
+
|
|
28
|
+
### Sass
|
|
29
|
+
|
|
30
|
+
`@octaviaflow/elements` provides two entrypoints for you to leverage: a bundled
|
|
31
|
+
entrypoint and a module entrypoint. For most use-cases, the bundled entrypoint
|
|
32
|
+
will work for you. If you have taken an extra step to configure your build
|
|
33
|
+
configuration to properly resolve `@import`s from files, then feel free to use
|
|
34
|
+
the module entrypoint.
|
|
35
|
+
|
|
36
|
+
To include the bundled entrypoint, you can include the following in your Sass
|
|
37
|
+
file:
|
|
38
|
+
|
|
39
|
+
```scss
|
|
40
|
+
@import '@octaviaflow/elements/scss/elements';
|
|
41
|
+
|
|
42
|
+
# Import a specific package nested in elements
|
|
43
|
+
@import '@octaviaflow/elements/scss/themes/g10';
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Include in the example above is how to access nested packages. These packages
|
|
47
|
+
are ones that you could optionally install as a package, like `@octaviaflow/themes`,
|
|
48
|
+
but we've included them inline as a convenience.
|
|
49
|
+
|
|
50
|
+
To include the module entrypoint, you can include the following in your Sass
|
|
51
|
+
file:
|
|
52
|
+
|
|
53
|
+
```scss
|
|
54
|
+
@import '@octaviaflow/elements/scss/index';
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### JavaScript
|
|
58
|
+
|
|
59
|
+
`@octaviaflow/elements` re-exports the exports from all of the packages that it
|
|
60
|
+
exports. That means that if an individual package exports a value, then you can
|
|
61
|
+
import it the same way when using `@octaviaflow/elements`. For example, with
|
|
62
|
+
`@octaviaflow/colors` we might write:
|
|
63
|
+
|
|
64
|
+
```js
|
|
65
|
+
import { colors } from '@octaviaflow/colors';
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
With `@octaviaflow/elements`, you can also import `colors`:
|
|
69
|
+
|
|
70
|
+
```js
|
|
71
|
+
import { colors } from '@octaviaflow/elements';
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## 🙌 Contributing
|
|
75
|
+
|
|
76
|
+
We're always looking for contributors to help us fix bugs, build new features,
|
|
77
|
+
or help us improve the project documentation. If you're interested, definitely
|
|
78
|
+
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀
|
|
79
|
+
|
|
80
|
+
## 📝 License
|
|
81
|
+
|
|
82
|
+
Licensed under the [Apache 2.0 License](/LICENSE).
|
|
83
|
+
|
|
84
|
+
## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
|
|
85
|
+
|
|
86
|
+
This package uses IBM Telemetry to collect de-identified and anonymized metrics
|
|
87
|
+
data. By installing this package as a dependency you are agreeing to telemetry
|
|
88
|
+
collection. To opt out, see
|
|
89
|
+
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
|
|
90
|
+
For more information on the data being collected, please see the
|
|
91
|
+
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
|
package/es/index.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { black, black100, blue, blue10, blue100, blue20, blue30, blue40, blue50, blue60, blue70, blue80, blue90, colors, coolGray, coolGray10, coolGray100, coolGray20, coolGray30, coolGray40, coolGray50, coolGray60, coolGray70, coolGray80, coolGray90, cyan, cyan10, cyan100, cyan20, cyan30, cyan40, cyan50, cyan60, cyan70, cyan80, cyan90, gray, gray10, gray100, gray20, gray30, gray40, gray50, gray60, gray70, gray80, gray90, green, green10, green100, green20, green30, green40, green50, green60, green70, green80, green90, magenta, magenta10, magenta100, magenta20, magenta30, magenta40, magenta50, magenta60, magenta70, magenta80, magenta90, orange, orange40, orange60, orange70, purple, purple10, purple100, purple20, purple30, purple40, purple50, purple60, purple70, purple80, purple90, red, red10, red100, red20, red30, red40, red50, red60, red70, red80, red90, rgba, teal, teal10, teal100, teal20, teal30, teal40, teal50, teal60, teal70, teal80, teal90, warmGray, warmGray10, warmGray100, warmGray20, warmGray30, warmGray40, warmGray50, warmGray60, warmGray70, warmGray80, warmGray90, white0, yellow, yellow20, yellow30, yellow40, yellow50 } from '@octaviaflow/colors';
|
|
2
|
+
export { fluid, fontFamilies, fontFamily, fontWeight, fontWeights, getTypeSize, print, reset, scale, styles, unstable_tokens } from '@octaviaflow/type';
|
|
3
|
+
export { baseFontSize, breakpoint, breakpointDown, breakpointUp, breakpoints, container, em, fluidSpacing, iconSize, miniUnit, miniUnits, px, rem, spacing } from '@octaviaflow/layout';
|
|
4
|
+
export * from '@octaviaflow/themes';
|
|
5
|
+
export { easings, fast01, fast02, moderate01, moderate02, motion, slow01, slow02 } from '@octaviaflow/motion';
|
package/index.scss
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright OctaviaFlow. 2025
|
|
3
|
+
//
|
|
4
|
+
// This source code is licensed under the Apache-2.0 license found in the
|
|
5
|
+
// LICENSE file in the root directory of this source tree.
|
|
6
|
+
//
|
|
7
|
+
|
|
8
|
+
@forward '@octaviaflow/colors';
|
|
9
|
+
@forward '@octaviaflow/themes';
|
|
10
|
+
@forward '@octaviaflow/layout';
|
|
11
|
+
@forward '@octaviaflow/grid' hide $prefix;
|
|
12
|
+
@forward '@octaviaflow/type' hide $prefix;
|
|
13
|
+
@forward '@octaviaflow/motion';
|