Skip to content

Shopify/restyle

Folders and files

NameName
Last commit message
Last commit date
Feb 2, 2023
Jan 27, 2023
Apr 11, 2023
Aug 18, 2023
Aug 18, 2023
Mar 28, 2023
Sep 6, 2019
Jan 27, 2023
Jul 16, 2020
Sep 6, 2019
Aug 18, 2023
Feb 25, 2020
Feb 25, 2020
Feb 25, 2020
Apr 3, 2023
Mar 30, 2023
Feb 3, 2023
Sep 9, 2019
Jan 19, 2023
Aug 18, 2023
Aug 18, 2023
Aug 18, 2023

Repository files navigation

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.