UNPKG

@ebay/skin

Version:

Skin - CSS modules that represent the brand eBay

opensource.ebay.com/skin/

eBay/skin

78 lines (40 loc) • 3.35 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/f1364dca/eBay-Skin) # Skin > Pure CSS framework designed & developed by eBay for a branded, e-commerce marketplace. Please visit the [Skin website](https://opensource.ebay.com/skin/) for all end-user documentation. ## License Skin is [MIT](LICENSE) licensed. ## Install Skin is available as the `@ebay/skin` package on [NPM](https://www.npmjs.com/). Skin is also available on our [CDN](https://opensource.ebay.com/skin/#cdn). ## Versioning Skin follows [Semantic Versioning](http://semver.org): 1. MAJOR version when we make incompatible API changes, 1. MINOR version when we add functionality in a backwards-compatible manner 1. PATCH version when we make backwards-compatible bug fixes. More detailed insight into our versioning process can be found in our [contributing guide](CONTRIBUTING.md). ## Releases Please refer to our [releases](https://github.com/eBay/skin/releases) page to view the change log for current and past releases. Please refer to our [web archive](https://opensource.ebay.com/skin/archive/) for past examples and documentation. ## Roadmap Please refer to our [projects](https://github.com/eBay/skin/projects) page to see what's coming down the pipeline. ## Browser Support Please view our [@ebay/browserslist-config](https://github.com/eBay/browserslist-config/blob/master/index.js) to see which browsers we currently support. _SPOILER_: we do not support IE10 or under. ## Accessibility (A11Y) We take accessibility very seriously. Very seriously indeed. Therefore all modules are built in accordance to the <a href="https://ebay.gitbooks.io/mindpatterns/content/">eBay MIND Patterns</a>. These patterns, in turn, build on from the specifications provided by the <a href="https://w3c.github.io/aria-practices/">WAI-ARIA Authoring Practices</a>. ## Issues Please use our [issues page](https://github.com/eBay/skin/issues) to ask questions, report issues or submit feature requests. To help track your issue, the Skin admins will assign it with a label from one or more issue categories. ## Custom Bundler Skin provides a command to create your own bundles for uploading to cdn. Use `bin/generate-bundle.js` in order to create separate bundles. `bin/generate-bundle.js list` -> List available modules (used for the --modules argument) `bin/generate-bundle.js bundle ebay` -> Create a bundle under the ebay folder `bin/generate-bundle.js bundle ebay --modules button carousel` -> Create a bundle under the ebay folder with only button and carousel modules `bin/generate-bundle.js bundle ebay --scope-class ebay --scope-specificity 5` -> Create a bundle under the ebay folder with all CSS styles wrapped under `.ebay.ebay.ebay.ebay.ebay {}` ## Developing &amp; Contributing Interested in contributing? Head over to our [contributing guide](CONTRIBUTING.md) for information on how to get started. Contributions don't have to be code! They can be ideas, inspiration, discussion or filing bugs! ## People The original creator of Skin is [Senthil Padmanabhan](https://github.com/senthilp). The current author and lead maintainer is [Ian McBurnie](https://github.com/ianmcburnie). [List of all contributors](https://github.com/eBay/skin/graphs/contributors).