useWidgetConfig

Returns the configuration of the widget, as defined in its mobro-widget-config.json.

function useWidgetConfig(): WidgetConfig | null

Returns

The widget configuration, typed as WidgetConfig exported by @modbros/dashboard-core. null if the configuration isn't available.

Example

src/widgets/example/Example.tsx

import React from 'react'
import {useWidgetConfig} from '@modbros/dashboard-sdk'
import type {WidgetConfig} from '@modbros/dashboard-core'

export default function Example() {
  const widgetConfig: WidgetConfig | null = useWidgetConfig()

  return <span>{widgetConfig?.displayName}</span>
}