--- title: "Get Started" slug: ovhcloud-design-system-get-started category: generic type: overview version: 20.0.0 tokens: 1174 source: https://ovh.github.io/design-system/v20.0.0/llms/ovhcloud-design-system-get-started.txt --- # Get Started OVHcloud Design System is a set of reusable React UI components to create a consistent user experience across OVHcloud pages and products, acting as a single source of truth. All OVHcloud Design System packages are available on [NPM](https://www.npmjs.com). ## Installation Include **ODS** in your projects like any other npm, pnpm or yarn module. `react` and `react-dom` (`v18.2+` or `v19+`) are peer dependencies: they must already be installed in your project. ```bash npm i --save-exact @ovhcloud/ods-react @ovhcloud/ods-themes ``` ```bash pnpm add --save-exact @ovhcloud/ods-react @ovhcloud/ods-themes ``` ```bash yarn add --exact @ovhcloud/ods-react @ovhcloud/ods-themes ``` ## Usage All components can be imported from the root path: ```tsx import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@ovhcloud/ods-react'; const App = () => { return ( Hello World! Lorem ipsum dolor sit amet. ); }; ``` Each component is also available as compound component from its subpath: ```tsx import { Accordion } from '@ovhcloud/ods-react/accordion'; const App = () => { return ( Hello World! Lorem ipsum dolor sit amet. ); }; ``` ## Import components constants All enums, interfaces, events are available directly from the `ods-react` lib ```typescript import { BUTTON_SIZE, type CheckboxProp } from '@ovhcloud/ods-react'; ``` ## Import theme & fonts You need to import a theme to display all the components correctly. It defines all the colors, typographies, etc. A theme names its fonts but does not load them: load them too. The default theme uses Source Sans 3 and Source Code Pro, which ODS ships with its icon font. via ES import: ```typescript import '@ovhcloud/ods-themes/default/css'; import '@ovhcloud/ods-themes/default/fonts'; ``` via Sass import: ```scss @use 'pkg:@ovhcloud/ods-themes/default/css'; @use '@ovhcloud/ods-themes/default/fonts'; ``` `pkg:` URLs require the [Node.js package importer](https://sass-lang.com/documentation/js-api/classes/nodepackageimporter/) (Sass `v1.71.1+`), enabled with `importers: [new NodePackageImporter()]` in your Sass options. The fonts stylesheet declares its font files with relative `url()`s, which Sass does not rewrite: keep a bare path for it, so your bundler (Vite for instance) resolves the file, rebases these URLs and emits the fonts. Through a `pkg:` URL, the URLs stay relative to your stylesheet and the fonts are not found. If your bundler does not rebase them, load the fonts from JavaScript instead, as in the ES import above. ODS ships three more themes, Aluminium dark, Blue Jeans and Blue Jeans dark, each to load instead of the default one. [Themes](https://ovh.github.io/design-system/v20.0.0/guides/themes) lists their imports and fonts, and explains how to switch between them, load the fonts when your setup cannot serve font files, or create your own theme. ## Server-side rendering ODS components rely on React state, effects and browser APIs: they cannot be used as React Server Components. With the Next.js App Router, import the theme in your root layout and use the components from client components, marked with the `'use client'` directive: ```tsx // app/layout.tsx import '@ovhcloud/ods-themes/default/css'; import '@ovhcloud/ods-themes/default/fonts'; import { type ReactNode } from 'react'; export default function RootLayout({ children }: { children: ReactNode }) { return ( { children } ); } ``` ```tsx // app/page.tsx 'use client'; import { Link } from '@ovhcloud/ods-react'; export default function Home() { return My ODS Link; } ``` The `Toaster` renders into `document.body` by default, which does not exist on the server, so the page fails to prerender with `document is not defined`. Pass `createPortal={ false }` to render it where it is placed, or render it only once the page is mounted in the browser. ## TypeScript To ensure the types are correctly resolved, you'll have to use the `bundler` module resolution, released with [TypeScript 5.0](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html#--moduleresolution-bundler). ```typescript "moduleResolution": "bundler" ```