@kiwicom/orbit-components
Version:
Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com's products.
42 lines • 1.66 kB
TypeScript
import * as React from "react";
import { defaultTokens } from "@kiwicom/orbit-design-tokens";
import type { Props } from "./types";
export declare const getCssVarsForWL: (theme: typeof defaultTokens) => {};
/**
* The OrbitProvider component provides theming and other Orbit features to the application.
*/
/**
* @orbit-doc-start
* README
* ----------
* # OrbitProvider
*
* orbit-components has theming support via our own `<OrbitProvider>` which adds you the possibility to add your own theme.
*
* ```jsx
* import OrbitProvider from "@kiwicom/orbit-components/lib/OrbitProvider";
* ```
*
* After adding import please wrap your application into `OrbitProvider` and you can provide your own [`theme`](https://github.com/kiwicom/orbit/blob/master/.github/theming.md).
*
* ```jsx
* <OrbitProvider theme={ownTheme}>
* <App />
* </OrbitProvider>
* ```
*
* ## Props
*
* Table below contains all types of the props available in the OrbitProvider component.
*
* | Name | Type | Default | Description |
* | :----------- | :----------- | :------ | :------------------------------------------------------------------------------- |
* | **children** | `React.Node` | | Your app |
* | theme | `[Object]` | | See [`theming`](https://github.com/kiwicom/orbit/blob/master/.github/theming.md) |
*
*
* @orbit-doc-end
*/
declare const OrbitProvider: ({ theme, children }: Props) => React.JSX.Element;
export default OrbitProvider;
//# sourceMappingURL=index.d.ts.map