@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
48 lines (30 loc) • 952 B
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CanKingDataProvider
# Function: CanKingDataProvider()
> **CanKingDataProvider**(`props`): `Element`
Creates a data provider to access CanKing data.
The CanKingDataProvider component is needed to be at the root of the component tree to
make it possible to use the CanKing UI Controls.
## Parameters
### props
Component properties.
#### children?
`ReactNode` = `undefined`
#### initialUserSettings?
[`IUserSettings`](../../models/interfaces/IUserSettings.md) = `undefined`
## Returns
`Element`
The CanKingDataProvider React component.
## Example
```tsx
const container = document.getElementById('root') as HTMLElement;
const root = createRoot(container);
root.render(
<React.StrictMode>
<CanKingDataProvider>
<App />
</CanKingDataProvider>
</React.StrictMode>,
);
```