Palette Mobile

@artsy/palette-mobile

Artsy's Design System on Mobile

Meta

• Point People: @brainbicycle @gkartalis
• Palette for Web: palette

What is Palette?

Palette is a collection of primitive, product-agnostic elements that help encapsulate Artsy's look and feel at base level. This project is intended to be used across our digital product portfolio.

Does my component belong in Palette?

If the component applies to Artsy as a brand and can/will be used across multiple digital products, then Palette is a great place for it. If it's highly product specific then it's best to leave the component where it's used. We can always move things later!

If the above guidance still doesn't give you a good sense of what to do, please join the mobile practice meetings.

How to install

• Install main library

yarn add @artsy/palette-mobile

• Install native peer deps

yarn add react-native-haptic-feedback react-native-linear-gradient react-native-reanimated react-native-svg

How to contribute

If you'd like to add a new component to Palette please create an issue using the component spec template. That'll give both design and engineering a chance to peek at the proposal and provide feedback before moving forward.

Local development

Set up using:

yarn setup:artsy
yarn install:all

Run using:

yarn start

And then either open Xcode and run, or Android Studio, or run yarn ios or yarn android from the command line, or just open up the simulator if you have done this before.

Developing Features using Local Versions of Palette

When developing new components in Palette, it's often useful to test those components in consuming apps (such as Eigen). However, due to the poor support for symlinks in React Native, this can be difficult. Enter yalc. Yalc is a mini package manager that one can publish to and install from, which makes it easy to test code in realtime from outside of your app.

Note: @artsy/palette-mobile uses Storybooks for developing features; work there first! Then, when ready (and if necessary), test your code locally using the flow described below. You can also publish npm canary releases from the palette-mobile repo by attaching a canary label to your PR.

Setup

• Install yalc globally:

yarn global add yalc

• Navigate to palette-mobile in the terminal and start the watcher:

cd palette-mobile
yarn local-palette-dev

• Navigate back to Eigen and link:

cd eigen
yarn local-palette-dev
yarn start

This will update package.json to point at the yalc-published version of palette.

• When done developing your local palette feature, be sure to unlink:

yarn local-palette-dev:stop

Repos consuming Palette Mobile

• Eigen
• Energy

You can add this library using yarn add @artsy/palette-mobile. Don't forget to also add all the peerDependencies to your project.

For connecting Palette to a locally running version of our mobile apps, see these docs.

About Artsy

This project is the work of designers and engineers at Artsy, the world's leading and largest online art marketplace and platform for discovering art. One of our core Engineering Principles is being Open Source by Default which means we strive to share as many details of our work as possible.

You can learn more about this work from our blog and by following @ArtsyOpenSource or explore our public data by checking out our API. If you're interested in a career at Artsy, read through our job postings!