Options
All
  • Public
  • Public/Protected
  • All
Menu

Package yarnpkg-libui

@yarnpkg/libui

This library is used to power parts of the UI in our interactive plugins.

Components

Application

A component that setups the state.

<ScrollableItems size={number} children={ReactEle}/>

A scrollable container which will display at most 2 * size + 1 lines of result on screen and will watch the up and down keys to scroll.

Note: The current implementation only supports children with an explicit key parameter and a height of exactly 1 row.

Hooks

useListItems

A key listener that watches for two keys (configurable through minus and plus) and triggers the set callback when either of them is pressed.

Type aliases

FocusRequestHandler

FocusRequestHandler: function

Type declaration

SubmitInjectedComponent

SubmitInjectedComponent<T, C>: React.ComponentType<InferProps<C> & object>

Type parameters

  • T

  • C

Variables

Const MinistoreContext

MinistoreContext: Context<null | object> = React.createContext<{getAll: () => Map<string, any>,get: (key: string) => any,set: (key: string, value: any) => void,} | null>(null)

Functions

Const Application

  • Application<T>(__namedParameters: object): Element

Const ItemOptions

  • ItemOptions<T>(__namedParameters: object): Element

Const ScrollableItems

  • ScrollableItems(__namedParameters: object): Element

renderForm

Const useFocusRequest

  • useFocusRequest(__namedParameters: object): void

Const useListInput

  • useListInput<T>(value: T, values: Array<T>, __namedParameters: object): void

useMinistore

  • useMinistore<T>(): Map<string, T>
  • useMinistore<T>(key: string, initialValue: T): [T, function]

Generated using TypeDoc