Stylable - CSS for components
Switch branches/tags
Clone or download
AviVahl Upgrade to react@16.6.3
- also upgrade @types/react and @types/webpack
- regenerate yarn.lock
Latest commit e04b021 Nov 14, 2018

README.md

Stylable CSS for Components

Travis Build Status AppVoyer Build Status

Stylable enables you to write reusable, highly-performant components. Each component exposes a style API that maps its internal parts so you can reuse components across teams without sacrificing stylability.

  • Scopes styles to components so they don't "leak" and clash with other styles.
  • Enables custom pseudo-classes and pseudo-elements that abstract the internal structure of a component. These can then be styled externally.
  • Cuts down on the resulting CSS bundles using "rule-shaking" and other optimizations

At build time, the preprocessor converts the Stylable CSS into a minimal, flat, static, valid vanilla CSS that works cross-browser.

Learn more in our Documentation Center.

Installation

There are two options for installing Stylable:

For details on both options, see Install & Configure.

Demos

Repository Structure

This repository is a mono-repo containing multiple packages that together comprise the Stylable ecosystem. It uses Lerna and Yarn workspaces to manage the various packages and their dependencies.

Core

Package Name Published Name Latest Version Description
core @stylable/core npm version Core CSS preprocessor
runtime @stylable/runtime npm version Runtime browser code

Tooling & Utilities

Package Name Published Name Latest Version Description
e2e-test-kit @stylable/e2e-test-kit npm version webpack project runner used for E2E testing
dom-test-kit @stylable/dom-test-kit npm version Stylable DOM related testing utils
cli @stylable/cli npm version Used for managing Stylable stylesheets in a project
react-scripts @stylable/react-scripts npm version create-react-app boilerplate generator scripts
stylable.io unpublished to npm - source for stylable.io
schema-extract @stylable/schema-extract npm version JSON Schema convertor for Stylable stylesheets

Integrations

Package Name Published Name Latest Version Description
jest @stylable/jest npm version Jest Stylable processor plugin
node @stylable/node npm version require hook and Node module factory
webpack-extensions @stylable/webpack-extensions npm version Experimental features for webpack integration
webpack-plugin @stylable/webpack-plugin npm version webpack (v4.x) integration plugin

External Packages

Package Name Description
stylable-intelligence VSCode extension providing language services for Stylable

Contributing

Read our contributing guidelines for details on our code of conduct, and the process for submitting pull requests.

License

Copyright (c) 2017 Wix.com Ltd. All Rights Reserved. Use of this source code is governed by a BSD license.