Back to Kibana

@kbn/workflows-ui

src/platform/packages/shared/kbn-workflows-ui/README.md

9.4.01.4 KB
Original Source

@kbn/workflows-ui

Shared React hooks and UI components for workflows functionality.

Hooks

useWorkflows

Hook to search and fetch workflows.

tsx
import { useWorkflows } from '@kbn/workflows-ui';
import type { WorkflowsSearchParams } from '@kbn/workflows';

const params: WorkflowsSearchParams = { size: 20, page: 1 };
const { data, isLoading, error } = useWorkflows(params);

Components

WorkflowSelector

A selectable dropdown component for choosing workflows with search, filtering, and validation support.

tsx
import { WorkflowSelector } from '@kbn/workflows-ui';
import type { WorkflowSelectorConfig } from '@kbn/workflows-ui';

const config: WorkflowSelectorConfig = {
  label: 'Select Workflow',
  placeholder: 'Choose a workflow...',
  filterFunction: (workflows) => workflows.filter(w => w.enabled),
  sortFunction: (workflows) => workflows.sort((a, b) => a.name.localeCompare(b.name)),
};

<WorkflowSelector
  selectedWorkflowId={workflowId}
  onWorkflowChange={(id) => setWorkflowId(id)}
  config={config}
  error={error}
  onCreateWorkflow={() => navigateToCreate()}
/>

Dependencies

  • @kbn/workflows - For workflow types and utilities
  • @kbn/react-query - For data fetching
  • @kbn/kibana-react-plugin - For Kibana services
  • @kbn/react-kibana-context-theme - For theme support (dark mode)
  • @kbn/i18n - For internationalization
  • @kbn/i18n-react - For React i18n components