Skip to main content

Interface: WorkerLayoutControlProps<T>

Properties for WorkerLayoutControl component

Type Parameters​

• T

Properties​

autoRunFor?​

optional autoRunFor: number

Option to tell what we do when the component is mounted

  • -1 means that we do nothing (it's the same as no value)
  • 0 means that we start the algo (and don't auto stop it)
  • X mans that we start the algo, and stop it after X milliseconds

Defined in​

WorkerLayoutControl.tsx:45

children?​

optional children: [Element, Element]

It's possible to customize the button, by passing to JSX Element. First one is for the "start layout", and the second to "stop layout". Example :

<WorkerLayoutControl>
  <>
    <span>Start</span>
    <span>Stop</span>
  </>
</WorkerLayoutControl>

Defined in​

WorkerLayoutControl.tsx:60

className?​

optional className: string

HTML class

Defined in​

WorkerLayoutControl.tsx:22

id?​

optional id: string

HTML id

Defined in​

WorkerLayoutControl.tsx:17

labels?​

optional labels: object

Map of the labels we use in the component. This is usefull for I18N

start​

start: undefined | string

stop​

stop: undefined | string

Defined in​

WorkerLayoutControl.tsx:66

layout​

layout: LayoutWorkerHook<T>

The layout hook to use

Defined in​

WorkerLayoutControl.tsx:32

settings​

settings: T

Settings of the layout.

Defined in​

WorkerLayoutControl.tsx:37

style?​

optional style: CSSProperties

HTML CSS style

Defined in​

WorkerLayoutControl.tsx:27