Skip to content

Latest commit

 

History

History
138 lines (105 loc) · 5.8 KB

README.md

File metadata and controls

138 lines (105 loc) · 5.8 KB
Raw

@siteed/design-system

kandi X-Ray Version Dependency Status License

Introduction

@siteed/design-system is a comprehensive cross-platform design system built around Expo for cross-platform applications. It extends react-native-paper to provide a robust set of UI components that are easy to implement and customize. Designed with an opinionated selection of libraries, it simplifies the integration process and reduces setup time, allowing developers to focus on building high-quality mobile apps efficiently.

Philosophy

The design system is currently under active development and is not production-ready at the moment. Components and features are being added as needed, typically when they are required for specific projects. Most components are wrappers around react-native-paper to provide a base for customization while maintaining backward compatibility. This allows for quick iteration and integration of new features without breaking existing implementations.

While the design system provides good defaults to get started quickly, users have the flexibility to choose the versions of all peer dependencies instead of hardcoding them as dependencies. This ensures compatibility and allows for greater control over the project's dependency management.

Key Features

  • Opinionated Library Choices: Includes essential libraries such as react-native-paper, react-native-safe-area-context, react-native-reanimated, react-native-paper-dates, ensuring compatibility and functionality.
  • Ready-to-Use Components: From typography to modals, get access to a variety of UI components that are production-ready and customizable.
  • Streamlined Configuration: Pre-configured settings and integrations to speed up the development process, making it ideal for rapid prototyping and production projects.

Installation

npx create-expo-app@latest
npx expo install @siteed/design-system @siteed/react-native-logger react-native-paper react-native-safe-area-context @gorhom/[email protected] react-native-gesture-handler @expo/vector-icons expo-localization react-native-reanimated react-native-screens react-native-vector-icons @react-navigation/native @react-native-community/slider
# we also use react-native-paper-dates for date pickers
npx expo install react-native-paper-dates react-native-localize @formatjs/intl-pluralrules @formatjs/intl-getcanonicallocales @formatjs/intl-listformat @formatjs/intl-displaynames @formatjs/intl-locale @formatjs/intl-datetimeformat @formatjs/intl-numberformat @formatjs/intl-relativetimeformat

with web support

npx expo install react-dom react-native-web @expo/metro-runtime react-native-web
npx expo customize metro.config.js

Usage

Quickly integrate the design system into your app by importing and using the provided components and utilities:

  • First overwrite the default entry point in main if you are using expo router.
{
  "name": "design-playground",
  "version": "1.0.1",
  "main": "src/index",
  ...
}

Then create a custom `src/index.tsx`

It is recommended to use the UIProvider at the root of your app to avoid issues with nested context when using modals.

import "intl-pluralrules";
// Keep polyfills at the top

import { UIProvider } from "@siteed/design-system/src";
import { registerRootComponent } from "expo";
import { App as ExpoRouterApp } from "expo-router/build/qualified-entry";

const AppEntry = () => {
  return (
    <UIProvider
      toastProviderProps={{
        overrides: {
          snackbarStyle: { marginBottom: 100 },
        },
      }}
    >
      <ExpoRouterApp />
    </UIProvider>
  );
};

registerRootComponent(AppEntry);

Finally you can have your regular code using the design system.

import { LabelSwitch, ScreenWrapper, UIProvider, useThemePreferences, Picker, SelectOption } from "@siteed/design-system";
import { StatusBar } from 'expo-status-bar';
import { StyleSheet, View } from 'react-native';
import { Text } from 'react-native-paper';
import React from 'react';

export function App() {
  const { toggleDarkMode, darkMode } = useThemePreferences()
  const [options, setOptions] = React.useState<SelectOption[]>([{ label: 'Option 1', value: 'option1', selected: true }, { label: 'Option 2', value: 'option2' }])
  return (
    <ScreenWrapper withScrollView contentContainerStyle={styles.container}>
      <Text>Open up App.tsx to start working on your app!</Text>
      <View style={{width: '100%'}}>
        <LabelSwitch label="Dark Mode" value={darkMode} onValueChange={toggleDarkMode} />
        <Picker label="Category" options={options} onFinish={setOptions} />
      </View>
      <StatusBar style={darkMode ? "light" : "dark"} />
    </ScreenWrapper>
  );
}

export default function WrapApp() {
  return (
      <UIProvider>
        <App />
      </UIProvider>
  )
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    width: '100%',
    alignItems: 'center',
    justifyContent: 'center',
  },
});

For a full list of components and their usage, you can explore the storybook

Documentation

For more detailed information on the design system and its components, check out the storybook site at https://deeeed.github.io/universe/design-system-storybook/

Storybook

Explore the components and their usage more thoroughly by running the Storybook locally:

yarn storybook