@shopify/restyle
TypeScript icon, indicating that this package has built-in type declarations

2.4.4 • Public • Published

Restyle Image

Getting startedInstallationPlaygroundDiscord

Build a consistent, themed UI in minutes.

RestyleTheme 2020-02-25 17_43_51

The Restyle library provides a type-enforced system for building UI components in React Native with TypeScript. It's a library for building UI libraries, with themability as the core focus.

This library assumes that the UI is built upon a design system that (at the very least) defines a set of colors and spacing constants that lays as a foundation. While the library acknowledges that there can be exceptions to the system by allowing any style to be overridden, it keeps the developer most productive when one-off values are kept to a minimum.

Installation

Add the package to your project using one of the following:

yarn add @shopify/restyle
npm install @shopify/restyle
npx expo install @shopify/restyle

Usage

See Usage in the documentation, or see below for the fixture app.

App / Playground

The fixture is an example app to showcase the library's usage.

Running the Documentation site locally

To run the Documentation site locally, please follow the steps below:

  1. cd documentation
  2. yarn
  3. yarn start
  4. Go to http://localhost:3000/restyle/

Migrating to restyle v2

Read more about migration to v2 here

Inspiration

Restyle is heavily inspired by https://styled-system.com.

Contributing

For help on setting up the repo locally, building, testing, and contributing please see CONTRIBUTING.md.

Code of Conduct

All developers who wish to contribute through code or issues, take a look at the CODE_OF_CONDUCT.md.

License

MIT, see LICENSE.md for details.

/@shopify/restyle/

    Package Sidebar

    Install

    npm i @shopify/restyle

    Weekly Downloads

    45,233

    Version

    2.4.4

    License

    MIT

    Unpacked Size

    100 kB

    Total Files

    48

    Last publish

    Collaborators

    • andyw8-shopify
    • antoine.grant
    • blittle
    • bpscott
    • crisfmb
    • goodforonefare
    • hannachen
    • henrytao
    • jaimie.rockburn
    • justin-irl
    • lemonmade
    • maryharte
    • megswim
    • nathanpjf
    • netlohan
    • pmoloney89
    • shopify-admin
    • shopify-dep
    • st999999
    • tsov
    • vividviolet
    • vsumner
    • wcandillon
    • wizardlyhel