Class ContentLinkView

A ContentView that renders a custom template, containing of 2 different components. The first element displays the information of a content item (containing title and icons of the content) and the buttonView renders a button that can be used to remove the displayed content.

Hierarchy

default
- ContentLinkView

Index

Constructors

constructor

new ContentLinkView(editor, renderOptions?): ContentLinkView
Parameters
- editor: default
- Optional renderOptions: {
      renderCancelButton?: boolean;
      renderStatusIcon?: boolean;
      renderTypeIcon?: boolean;
  }
  - Optional renderCancelButton?: boolean
  - Optional renderStatusIcon?: boolean
  - Optional renderTypeIcon?: boolean
Returns ContentLinkView
Overrides ButtonView.constructor
- Defined in packages/ckeditor5-coremedia-link/src/contentlink/ui/ContentLinkView.ts:44

Properties

ariaLabelText

ariaLabelText: string

contentName

contentName: undefined | string

renderAsTextLink

renderAsTextLink: boolean

`Readonly` renderOptions

renderOptions: undefined | {
    renderCancelButton?: boolean;
    renderStatusIcon?: boolean;
    renderTypeIcon?: boolean;
}

Type declaration

Optional renderCancelButton?: boolean
Optional renderStatusIcon?: boolean
Optional renderTypeIcon?: boolean

underlined

underlined: boolean

uriPath

uriPath: undefined | null | string

Accessors

cancelButton

get cancelButton(): undefined | default
Returns undefined | default
- Defined in packages/ckeditor5-coremedia-link/src/contentlink/ui/ContentLinkView.ts:227

Methods

destroy

destroy(): void
Returns void
Overrides ButtonView.destroy
- Defined in packages/ckeditor5-coremedia-link/src/contentlink/ui/ContentLinkView.ts:231

hasUriPathProperty

hasUriPathProperty(obj): obj is {
uriPath: string;
}
Parameters
- obj: object
Returns obj is {
uriPath: string;
}
- Defined in packages/ckeditor5-coremedia-link/src/contentlink/ui/ContentLinkView.ts:156

render

render(): void
Returns void
Overrides ButtonView.render
- Defined in packages/ckeditor5-coremedia-link/src/contentlink/ui/ContentLinkView.ts:162

Class ContentLinkView

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

`Optional` renderCancelButton?: boolean

`Optional` renderStatusIcon?: boolean

`Optional` renderTypeIcon?: boolean

Returns ContentLinkView

Properties

ariaLabelText

contentName

renderAsTextLink

`Readonly` renderOptions

Type declaration

`Optional` renderCancelButton?: boolean

`Optional` renderStatusIcon?: boolean

`Optional` renderTypeIcon?: boolean

underlined

uriPath

Accessors

cancelButton

Returns undefined | default

Methods

destroy

Returns void

hasUriPathProperty

Parameters

Returns obj is {
uriPath: string;
}

render

Returns void

Settings

Member Visibility

Theme

On This Page

Class ContentLinkView

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional renderCancelButton?: boolean

Optional renderStatusIcon?: boolean

Optional renderTypeIcon?: boolean

Returns ContentLinkView

Properties

ariaLabelText

contentName

renderAsTextLink

Readonly renderOptions

Type declaration

Optional renderCancelButton?: boolean

Optional renderStatusIcon?: boolean

Optional renderTypeIcon?: boolean

underlined

uriPath

Accessors

cancelButton

Returns undefined | default

Methods

destroy

Returns void

hasUriPathProperty

Parameters

Returns obj is { uriPath: string; }

render

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` renderCancelButton?: boolean

`Optional` renderStatusIcon?: boolean

`Optional` renderTypeIcon?: boolean

`Readonly` renderOptions

`Optional` renderCancelButton?: boolean

`Optional` renderStatusIcon?: boolean

`Optional` renderTypeIcon?: boolean

Returns obj is {
uriPath: string;
}