Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SiderConfig

Hierarchy

Implements

Index

Properties

Properties

Optional appendTo

appendTo: string | Element | JQuery = "body"

Optional cls

cls: string = ""

The CSS class to add to this widget's element

Optional colorMode

colorMode: ColorMode

Optional escKey

escKey: boolean

Whether you want to enable users to use ESC to hide a panel.

default

true

Optional faceMode

faceMode: SiderFaceMode = SiderFaceMode.over
default

SiderFaceMode.over

Optional height

height: string | number

Optional hidden

hidden: boolean = true

Optional html

html: string | Element | JQuery

Optional i18n

i18n: I18NResource | URLString = null

I18N resource.

Optional Readonly id

id: string

Optional listeners

listeners: SiderListeners

Optional locale

locale: Locale = "en"

A locale string, like 'en', 'en-us', 'zh'.

Optional name

name: string = ""

Optional place

place: "left" | "right"

Where you want to show a side panel from. You can only set it to either left or right.

default

'left'

Optional renderTo

renderTo: string | Element | JQuery = null

Render to DOM element.

Optional sizeMode

sizeMode: SizeMode = SizeMode.md

Optional speed

speed: number

Animating time for showing a side panel. The unit is millisecond.

Optional style

style: string = ""

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

Optional tip

tip: string = ""

Optional title

title: string

Optional titleCls

titleCls: string

Optional titleStyle

titleStyle: string

Optional trigger

trigger: string | Element | JQuery

DOM element that you want to use as a trigger to show and hide a panel.

Optional url

url: string

Optional width

width: string | number

Width of a side panel. Integer value will be evaluated as px. String value will be assigned directly e.g. '100px', '50%'