Function: registerPluginSettings()

function registerPluginSettings(
   name: string, 
   component: PluginSettingsComponentType, 
   displaySaveButton?: boolean): void;

Defined in: plugin/registry.tsx:770

Register a plugin settings component.

Parameters

Parameter	Type	Default value	Description
name	string	undefined	The name of the plugin.
component	PluginSettingsComponentType	undefined	The component to use for the settings.
displaySaveButton	boolean	false	Whether to display the save button.

Returns

void

void

Example

import { registerPluginSettings } from '@kinvolk/headlamp-plugin/lib';
import { TextField } from '@mui/material';

function MyPluginSettingsComponent(props: PluginSettingsDetailsProps) {
  const { data, onDataChange } = props;

  function onChange(value: string) {
    if (onDataChange) {
      onDataChange({ works: value });
    }
  }

  return (
    <TextField
      value={data?.works || ''}
      onChange={e => onChange(e.target.value)}
      label="Normal Input"
      variant="outlined"
      fullWidth
    />
  );
}

const displaySaveButton = true;
// Register a plugin settings component.
registerPluginSettings('my-plugin', MyPluginSettingsComponent, displaySaveButton);

More complete plugin settings example in plugins/examples/change-logo:

See

Change Logo Example