@trilogy-ds/react
v0.0.1-beta-sc-1
Published
Trilogy react framework design system for Bouygues Telecom
Downloads
1,682
Readme
Trilogy DS
🚀 Quick Start
Trilogy DS, developed by Bouygues Telecom, is a multiplatform design system ( Web / React / React Native ) with reusable components with same codebase.
Structure
.
├── react
├── components # ◀ React functional components
├── context # Providers (Themes , styles / hashed styles)
├── events # Event type definitions
├── helpers # Utility functions
├── objects # Atoms & facets definition & implementation
├── services # Hooks
└── types # Typescript types
Usage
npm i @trilogy-ds/react
import { Button, Text } from '@trilogy-ds/react';
<Button variant='PRIMARY'>My Button</Button>
<Text level='1'>My Text</Text>
Trilogy Provider - Import directly css styles
The TrilogyProvider simplifies integrating Trilogy style into your app by wrapping your entry point with a provider. It offers two props for customization:
mangled
[optional]: Apply compressed styling for performance.injectTrilogyAssets
: Inject Trilogy assets directly into the DOM.
Web Usage
Import the
TrilogyProvider
component:import { TrilogyProvider } from "@trilogy-ds/react/lib/context/provider"
Wrap your app's root component with it:
<TrilogyProvider mangled injectTrilogyAssets> <App /> </TrilogyProvider>
Native Usage
Import the
TrilogyThemeProvider
along withSVGicons
& colors from @trilogy-ds/assets library:import { TrilogyThemeProvider, defaultTheme } from '@trilogy-ds/react/lib/context/providerTheme' import { SVGicons } from '@trilogy-ds/assets/lib/iconsPath'
Wrap your app's root component with it:
const theme = { ...defaultTheme, icons: SVGicons, // here: override theme colors } <TrilogyThemeProvider theme={theme}> <AppNative /> </TrilogyThemeProvider>
Environment
Web
Mobile (Android / IOS)
- Java
- cocoapods (>= 1.10.1) (only for ios)
- Xcode (>= 12.5.1) (only for ios)
- Android Studio (>= 4.2.2) (only for android)
See how to setup your environment for Android and IOS
Example
Check out our example project using Trilogy for consumption.
Contributing
Read the contributing guide to become familiar with our development process, suggest fixes for bugs and improvements, and understand how to construct and assess your modifications
Changelog
The changelog is consistently refreshed to show the modifications made in each new version.