LabIcon | @jupyterlab (original) (raw)

Implements

• ILabIcon
• IRenderer

Index

Constructors

constructor

• new LabIcon(
  __namedParameters: LabIcon.IOptions & { _loading?: boolean },
  ): LabIcon

• Returns LabIcon

Properties

Protected_className

_className: string

Protected_loading

_loading: boolean

Protected_props

Protected_svgElement

_svgElement: undefined | null | HTMLElement = undefined

Protected_svgInnerHTML

_svgInnerHTML: undefined | null | string = undefined

Protected_svgReactAttrs

_svgReactAttrs: any = undefined

Protected_svgReplaced

Protected_svgstr

_svgstr: string

Protected_uuid

_uuid: string

Readonlyname

name: string

Readonlyreact

Accessors

ProtectedsvgElement

• get svgElement(): null | HTMLElement

• Returns null | HTMLElement

ProtectedsvgInnerHTML

• get svgInnerHTML(): null | string

• Returns null | string

ProtectedsvgReactAttrs

• get svgReactAttrs(): any

• Returns any

svgstr

• get svgstr(): string

• Returns string

• set svgstr(svgstr: string): void

• Returns void

Methods

Protected_initReact

• _initReact(
  displayName: string,
  ): ForwardRefExoticComponent<LabIcon.IProps & RefAttributes<SVGElement>>

• Parameters

  • displayName: string

Returns ForwardRefExoticComponent<LabIcon.IProps & RefAttributes<SVGElement>>

Protected_initRender

• _initRender(__namedParameters: Partial<IRenderer>): void

• Returns void

Protected_initSvg

• _initSvg(
  __namedParameters?: { title?: string; uuid?: string },
  ): null | HTMLElement

• Parameters

  • __namedParameters: { title?: string; uuid?: string } = {}

Returns null | HTMLElement

bindprops

• bindprops(props?: LabIcon.IProps): LabIcon

• Returns LabIcon

a view of this LabIcon instance

element

• element(props?: LabIcon.IProps): HTMLElement

• Returns HTMLElement

A DOM element that contains an (inline) svg element that displays an icon

render

• render(container: HTMLElement, options?: LabIcon.IRendererOptions): void

• Returns void

Optionalunrender

• unrender(container: HTMLElement, options?: LabIcon.IRendererOptions): void

• Returns void

Staticremove

• remove(container: HTMLElement): HTMLElement

• Returns HTMLElement

the cleaned container

Staticresolve

• resolve(options: { icon: IRenderMime.LabIcon.IResolvable }): LabIcon

• Returns LabIcon

a LabIcon instance

StaticresolveElement

• resolveElement(
  __namedParameters: Partial<IResolverProps> & LabIcon.IProps,
  ): HTMLElement

• Returns HTMLElement

a DOM node with the resolved icon rendered into it

StaticresolveReact

• resolveReact(
  __namedParameters: Partial<IResolverProps> & LabIcon.IProps & RefAttributes<
  SVGElement,
  >,
  ): Element

• Returns Element

a React component that will render the resolved icon

StaticresolveSvg

• resolveSvg(__namedParameters: LabIcon.IIcon): null | HTMLElement

• Returns null | HTMLElement

StatictoggleDebug

• toggleDebug(debug?: boolean): void

• Parameters

  • Optionaldebug: boolean

Returns void