| 123456789101112131415161718192021222324252627282930313233343536373839 |
- import { Meta } from '@storybook/addon-docs/blocks';
- <Meta title="Docs/Getting Started/Quick Start" />
- # Getting Started
- ## Installing
- You can install NCore Web (ncore-web) with [NPM](https://www.npmjs.com/package/ncore-web) or Yarn.
- - NPM: `npm install ncore-web --save`
- - YARN: `yarn add ncore-web`
- ## Configuration
- You must wrap with NCoreProvider your outermost component. This is important for tools such as theme and localization to be active.
- NCoreProvider allows with a prop named "configs" you to make changes to themes and language packs and select initial theme and initial language.
- ```jsx
- <NCoreProvider
- configs={{
- themes: [
- // ... (theme schemes)
- ],
- designTokens: {
- // ... (design token schemes)
- },
- localeS: [
- // ... (locale schemes)
- ],
- initialThemeKey: string // initial theme key.
- initialLanguage: string // initial language key.
- }}
- >
- <Button title="Button"/>
- </NCoreProvider>
- ```
- If you want to set config, please look at Configs and Schemes Pages.
|