Kui API Documentation - v11.0.0 / @kui-shell/plugin-client-common / Kui

Class: Kui

Render the main body of our client.

|Notes on Session Initialization|: to provide custom views for session initialization (only relevant for browser-based hosted Kui), you can instantiate with these properties (defined in KuiConfiguration), show here with some sample views:

<Kui loading={

Hold on...

} reinit={

Connection broken...

} loadingError={err =>

{err.toString()}

} loadingDone={

Welcome to Kui

} />

Hierarchy

PureComponent<KuiProps, State>

↳ Kui

UNSAFE_componentWillMount
UNSAFE_componentWillReceiveProps
UNSAFE_componentWillUpdate
componentDidCatch
componentDidMount
componentDidUpdate
componentWillMount
componentWillReceiveProps
componentWillUnmount
componentWillUpdate
defaultFeatureFlag
defaultLoading
defaultLoadingDone
defaultLoadingError
defaultReinit
defaultSessionBehavior
forceUpdate
getSnapshotBeforeUpdate
onTabReady
onThemeChange
render
setState
shouldComponentUpdate
statusStripeProps

Constructors

constructor

• new Kui(props)

Parameters

Name	Type
`props`	`KuiProps`

Overrides

React.PureComponent<Props, State>.constructor

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:87

Properties

_onTabReady

• Private Readonly _onTabReady: any

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:273

context

• context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

see https://reactjs.org/docs/context.html

Inherited from

React.PureComponent.context

Defined in

node_modules/@types/react/index.d.ts:479

firstTab

• Private firstTab: boolean = true

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:260

props

• Readonly props: Readonly<KuiProps> & Readonly<{ children?: ReactNode }>

Inherited from

React.PureComponent.props

Defined in

node_modules/@types/react/index.d.ts:504

refs

• refs: Object

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Index signature

▪ [key: string]: ReactInstance

Inherited from

React.PureComponent.refs

Defined in

node_modules/@types/react/index.d.ts:510

state

• state: Readonly<State>

Inherited from

React.PureComponent.state

Defined in

node_modules/@types/react/index.d.ts:505

contextType

▪ Static Optional contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render() {
    return <>My context's value: {this.context}</>
  }
}

see https://reactjs.org/docs/context.html#classcontexttype

Inherited from

React.PureComponent.contextType

Defined in

node_modules/@types/react/index.d.ts:461

Methods

UNSAFE_componentWillMount

▸ Optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillMount

Defined in

node_modules/@types/react/index.d.ts:717

UNSAFE_componentWillReceiveProps

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
`nextProps`	`Readonly`<`KuiProps`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:749

UNSAFE_componentWillUpdate

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
`nextProps`	`Readonly`<`KuiProps`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:777

componentDidCatch

▸ componentDidCatch(error, errorInfo): void

Parameters

Name	Type
`error`	`Error`
`errorInfo`	`ErrorInfo`

Returns

void

Overrides

React.PureComponent.componentDidCatch

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:256

componentDidMount

▸ Optional componentDidMount(): void

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Inherited from

React.PureComponent.componentDidMount

Defined in

node_modules/@types/react/index.d.ts:625

componentDidUpdate

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters

Name	Type
`prevProps`	`Readonly`<`KuiProps`>
`prevState`	`Readonly`<`State`>
`snapshot?`	`any`

Returns

void

Inherited from

React.PureComponent.componentDidUpdate

Defined in

node_modules/@types/react/index.d.ts:688

componentWillMount

▸ Optional componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

React.PureComponent.componentWillMount

Defined in

node_modules/@types/react/index.d.ts:703

componentWillReceiveProps

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
`nextProps`	`Readonly`<`KuiProps`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:732

componentWillUnmount

▸ Optional componentWillUnmount(): void

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns

void

Inherited from

React.PureComponent.componentWillUnmount

Defined in

node_modules/@types/react/index.d.ts:641

componentWillUpdate

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
`nextProps`	`Readonly`<`KuiProps`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:762

defaultFeatureFlag

▸ Private defaultFeatureFlag(): Object

Returns

Object

Name	Type
`showWelcomeMax`	`number`
`sidecarName`	`string`

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:164

defaultLoading

▸ Private defaultLoading(): Element

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:171

defaultLoadingDone

▸ Private defaultLoadingDone(): (repl: default) => Element

Returns

fn

▸ (repl): Element

Parameters

Name	Type
`repl`	`default`

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:191

defaultLoadingError

▸ Private defaultLoadingError(): (err: any) => Element

Returns

fn

▸ (err): Element

Parameters

Name	Type
`err`	`any`

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:195

defaultReinit

▸ Private defaultReinit(): Element

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:177

defaultSessionBehavior

▸ Private defaultSessionBehavior(): KuiConfiguration

For browser-based clients, this defines the default UI for session initialization.

Returns

KuiConfiguration

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:209

forceUpdate

▸ forceUpdate(callback?): void

Parameters

Name	Type
`callback?`	() => `void`

Returns

void

Inherited from

React.PureComponent.forceUpdate

Defined in

node_modules/@types/react/index.d.ts:496

getSnapshotBeforeUpdate

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

Parameters

Name	Type
`prevProps`	`Readonly`<`KuiProps`>
`prevState`	`Readonly`<`State`>

Returns

any

Inherited from

React.PureComponent.getSnapshotBeforeUpdate

Defined in

node_modules/@types/react/index.d.ts:682

onTabReady

▸ Private onTabReady(): void

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:261

onThemeChange

▸ Private onThemeChange(__namedParameters): void

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.themeModel`	`Theme`

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:223

render

▸ render(): Element

Returns

Element

Overrides

React.PureComponent.render

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:275

setState

▸ setState<K>(state, callback?): void

Type parameters

Name	Type
`K`	extends keyof `ThemeProperties` \| keyof `InputProps` \| keyof `SessionProps` \| keyof `BrandingProps` \| keyof `FeatureFlags` \| `"_for_testing_"` \| `"userOverrides"` \| `"isBootstrapped"` \| `"commandLine"` \| `"quietExecCommand"`

Parameters

Name	Type
`state`	`State` \| (`prevState`: `Readonly`<`State`>, `props`: `Readonly`<`KuiProps`>) => `State` \| `Pick`<`State`, `K`> \| `Pick`<`State`, `K`>
`callback?`	() => `void`

Returns

void

Inherited from

React.PureComponent.setState

Defined in

node_modules/@types/react/index.d.ts:491

shouldComponentUpdate

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters

Name	Type
`nextProps`	`Readonly`<`KuiProps`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

boolean

Inherited from

React.PureComponent.shouldComponentUpdate

Defined in

node_modules/@types/react/index.d.ts:636

statusStripeProps

▸ Private statusStripeProps(): Props

Props to pass to StatusStripe. This allows us to set the desired status stripe color at startup time, rather than seeing the default color, followed quickly by a change to the color desired by the controller backing the given props.commandLine. The controller may still want to specialize the status stripe further, but at least we can avoid that odd e.g. defaultColor-then-blue effect.

Returns

Props

Defined in

plugins/plugin-client-common/src/components/Client/Kui.tsx:247

Files

kui_shell_plugin_client_common.Kui.md

Latest commit

History

kui_shell_plugin_client_common.Kui.md

File metadata and controls

Class: Kui

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters

Overrides

Defined in

Properties

_onTabReady

Defined in

context

Inherited from

Defined in

firstTab

Defined in

props

Inherited from

Defined in

refs

Index signature

Inherited from

Defined in

state

Inherited from

Defined in

contextType

Inherited from

Defined in

Methods

UNSAFE_componentWillMount

Returns

Inherited from

Defined in

UNSAFE_componentWillReceiveProps

Parameters

Returns

Inherited from

Defined in

UNSAFE_componentWillUpdate

Parameters

Returns

Inherited from

Defined in

componentDidCatch

Parameters

Returns

Overrides

Defined in

componentDidMount

Returns

Inherited from

Defined in

componentDidUpdate

Parameters

Returns

Inherited from

Defined in

componentWillMount

Returns

Inherited from

Defined in

componentWillReceiveProps

Parameters

Returns

Inherited from

Defined in

componentWillUnmount

Returns

Inherited from

Defined in