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

Class: TabContent

@kui-shell/plugin-client-common.TabContent

TabContent ---------------- from here down | ST | | | | | | | | | | | | | | | | |

ST:

Hierarchy

PureComponent<Props, State>

↳ TabContent

UNSAFE_componentWillMount
UNSAFE_componentWillReceiveProps
UNSAFE_componentWillUpdate
_onClear
_resetSplitLayout
_toggleAttribute
_toggleBottomStripMode
_toggleLeftStripMode
body
bottom
children
componentDidCatch
componentDidMount
componentDidUpdate
componentWillMount
componentWillReceiveProps
componentWillUnmount
componentWillUpdate
defaultLoading
forceUpdate
getSnapshotBeforeUpdate
graft
initTab
onOffline
oneTimeInit
proxyDisconnectNotice
render
setEditMode
setState
shouldComponentUpdate
tabClassName
terminal
toggleEditMode
delayedFocus
getDerivedStateFromProps
onSessionInitError

Constructors

constructor

• new TabContent(props)

Parameters

Name	Type
`props`	`Props`

Overrides

React.PureComponent<Props, State>.constructor

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:113

Properties

_firstRenderDone

• Private _firstRenderDone: boolean = false

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:94

activateHandlers

• Private activateHandlers: (isActive: boolean) => void[] = []

switching back or away from this tab

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:99

cleaners

• Private Readonly cleaners: Cleaner[] = []

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:96

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

props

• Readonly props: Readonly<Props> & 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`<`Props`>
`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`<`Props`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillUpdate

Defined in

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

_onClear

▸ Private Readonly _onClear(): void

Request to clear the contents of the ScrollableTerminal

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:314

_resetSplitLayout

▸ Private Readonly _resetSplitLayout(): void

Reset any notion of left strip etc.

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:297

_toggleAttribute

▸ Private Readonly _toggleAttribute(attr): void

Toggle attribute on Tab DOM

Parameters

Name	Type
`attr`	`string`

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:307

_toggleBottomStripMode

▸ Private Readonly _toggleBottomStripMode(): void

Enter/exit mode where one split is displayed along the bottom

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:303

_toggleLeftStripMode

▸ Private Readonly _toggleLeftStripMode(): void

Enter/exit mode where one split is displayed along the left

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:300

body

▸ Private body(): Element

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:414

bottom

▸ Private bottom(): ReactElement<WithTabUUID & WithTab<Tab>, string | JSXElementConstructor<any>>

Graft on the tab uuid

Returns

ReactElement<WithTabUUID & WithTab<Tab>, string | JSXElementConstructor<any>>

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:393

children

▸ Private children(): Object

Graft on the REPL focus management

Returns

Object

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:384

componentDidCatch

▸ Optional componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters

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

Returns

void

Inherited from

React.PureComponent.componentDidCatch

Defined in

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

componentDidMount

▸ componentDidMount(): void

Returns

void

Overrides

React.PureComponent.componentDidMount

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:151

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`<`Props`>
`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`<`Props`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.componentWillReceiveProps

Defined in

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

componentWillUnmount

▸ componentWillUnmount(): void

Returns

void

Overrides

React.PureComponent.componentWillUnmount

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:286

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`<`Props`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

void

Inherited from

React.PureComponent.componentWillUpdate

Defined in

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

defaultLoading

▸ Private defaultLoading(): string

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:291

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`<`Props`>
`prevState`	`Readonly`<`State`>

Returns

any

Inherited from

React.PureComponent.getSnapshotBeforeUpdate

Defined in

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

graft

▸ Private graft(node, key?): Object

Parameters

Name	Type
`node`	`ReactNode`
`key?`	`number`

Returns

Object

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:370

initTab

▸ Private initTab(tab): void

Parameters

Name	Type
`tab`	`Tab`

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:237

onOffline

▸ Private onOffline(): Promise<void>

Returns

Promise<void>

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:192

oneTimeInit

▸ Private oneTimeInit(): Object

Returns

Object

Name	Type
`sessionInit`	`string`

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:210

proxyDisconnectNotice

▸ Private proxyDisconnectNotice(): Element

Use client-provided (or default) proxy disconnected notice, if warranted

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:352

render

▸ render(): Element

Returns

Element

Overrides

React.PureComponent.render

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:451

setEditMode

▸ Private Readonly setEditMode(value): () => void

Parameters

Name	Type
`value`	`boolean`

Returns

fn

▸ (): void

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:107

setState

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

Type parameters

Name	Type
`K`	extends `"active"` \| keyof `WithTab`<`RefObject`<`Tab`>> \| `"sessionInit"` \| `"sessionInitError"` \| `"showSessionInitDone"` \| `"hasLeftStrip"` \| `"hasBottomStrip"` \| `"_terminal"` \| `"mutability"`

Parameters

Name	Type
`state`	`State` \| (`prevState`: `Readonly`<`State`>, `props`: `Readonly`<`Props`>) => `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`<`Props`>
`nextState`	`Readonly`<`State`>
`nextContext`	`any`

Returns

boolean

Inherited from

React.PureComponent.shouldComponentUpdate

Defined in

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

tabClassName

▸ Private tabClassName(): string

Construct the className property of the tab element

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:406

terminal

▸ Private terminal(): Element

Returns

Element

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:323

toggleEditMode

▸ Private Readonly toggleEditMode(): void

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:101

delayedFocus

▸ Static delayedFocus(state, delayMillis?): void

Parameters

Name	Type	Default value
`state`	`State`	`undefined`
`delayMillis`	`number`	`300`

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:141

getDerivedStateFromProps

▸ Static getDerivedStateFromProps(props, state): State

Parameters

Name	Type
`props`	`Props`
`state`	`State`

Returns

State

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:128

onSessionInitError

▸ Static Private onSessionInitError(uuid, sessionInitError): void

Parameters

Name	Type
`uuid`	`string`
`sessionInitError`	`Error`

Returns

void

Defined in

plugins/plugin-client-common/src/components/Client/TabContent.tsx:206

Files

kui_shell_plugin_client_common.TabContent.md

Latest commit

History

kui_shell_plugin_client_common.TabContent.md

File metadata and controls

Class: TabContent

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters

Overrides

Defined in

Properties

_firstRenderDone

Defined in

activateHandlers

Defined in

cleaners

Defined in

context

Inherited from

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

_onClear

Returns

Defined in

_resetSplitLayout

Returns

Defined in

_toggleAttribute

Parameters

Returns

Defined in

_toggleBottomStripMode

Returns

Defined in

_toggleLeftStripMode

Returns

Defined in

body

Returns

Defined in

bottom

Returns

Defined in

children

Returns

Defined in