Ignite UI for Angular

すべて
  • パブリック
  • パブリック/保護
  • すべて

Class IgxSwitchComponent

Switch コンポーネントは、バイナリ選択の選択コンポーネントです。

Igx Module

IgxSwitchModule

Igx Theme

igx-switch-theme, igx-tooltip-theme

Igx Keywords

switch, states, tooltip

Igx Group

データ入力 & 表示

備考

Ignite UI Switch はオン/オフまたは true/false 状態の間に切り替えます。

例

<igx-switch [checked]="true">
  Simple switch
</igx-switch>

階層

Hierarchy

  • CheckboxBaseDirective
    • IgxSwitchComponent

実装

  • ControlValueAccessor
  • EditorProvider
  • AfterViewInit

コンストラクター

プロパティ

アクセサー

コンストラクター

constructor

プロパティ

ariaLabel

ariaLabel: string = null

aria-label 属性の値を取得または設定します。

例

<igx-checkbox aria-label="Checkbox1"></igx-checkbox>

let ariaLabel = this.checkbox.ariaLabel;

ariaLabelledBy

ariaLabelledBy: string = ...

aria-labelledby 属性を設定または取得します。 設定されない場合、aria-labelledby の値は labelId 属性の値と等しくなります。

例

<igx-checkbox aria-labelledby="Checkbox1"></igx-checkbox>

let ariaLabelledBy = this.checkbox.ariaLabelledBy;

Readonlychange

change: EventEmitter<IChangeCheckboxEventArgs> = ...

チェックボックス状態が変更された後に発生するイベントです。 イベント引数として IgxCheckboxComponent および checked プロパティへの参照を提供します。

cssClass

cssClass: string = 'igx-switch'

switch コンポーネントのクラスを返します。

例

let switchClass = this.switch.cssClass;

disabled

disabled: boolean = false

disabled 属性を取得または設定します。 デフォルト値は false です。

例

<igx-switch disabled><igx-switch>

disableRipple

disableRipple: boolean = false

リップル効果を有効または無効にします。 設定されていない場合、disableRipple の値は false になります。

例

<igx-checkbox [disableRipple]="true"></igx-checkbox>

let isRippleDisabled = this.checkbox.desableRipple;

focused

focused: boolean = false

switch コンポーネントがフォーカスされるかどうかを取得または設定します。 デフォルト値は false です。

例

this.switch.focused = true;

id

id: string = ...

チェックボックス コンポーネントの id を取得または設定します。 最初のチェックボックス コンポーネントの id は "igx-checkbox-0" になります。

例

<igx-checkbox id="my-first-checkbox"></igx-checkbox>

let checkboxId =  this.checkbox.id;

indeterminate

indeterminate: boolean

invalid

invalid: boolean = false

Switch コンポーネントが無効かどうかを設定または取得します。 デフォルト値は false です。

例

<igx-switch invalid></igx-switch>

let isInvalid = this.switch.invalid;

labelId

labelId: string = ...

label 要素の id を取得または設定します。設定されない場合、最初のチェックボックス コンポーネントの label の id は "igx-checkbox-0-label" になります。

例

<igx-checkbox labelId="Label1"></igx-checkbox>

let labelId =  this.component.labelId;

labelPosition

labelPosition: string = LabelPosition.AFTER

label の位置を取得または設定します 設定されていない場合、labelPosition は "after" です。

例

<igx-checkbox labelPosition="before"></igx-checkbox>

let labelPosition =  this.checkbox.labelPosition;

name

name: string

name 属性を設定または取得します。

例

<igx-checkbox name="Checkbox1"></igx-checkbox>

let name =  this.checkbox.name;

nativeInput

nativeInput: ElementRef<any>

ネイティブ チェックボックス要素への参照を返します。

例

let checkboxElement =  this.component.checkboxElement;

nativeLabel

nativeLabel: ElementRef<any>

ネイティブ ラベル要素への参照を返します。


@example
let labelElement =  this.component.nativeLabel;

ngControl

ngControl: NgControl

placeholderLabel

placeholderLabel: ElementRef<any>

ラベル プレースホルダー要素への参照を返します。


@example
let labelPlaceholder =  this.component.placeholderLabel;

readonly

readonly: boolean

tabindex

tabindex: number = null

tabindex 属性の値を取得または設定します。

例

<igx-checkbox [tabindex]="1"></igx-checkbox>

let tabIndex =  this.checkbox.tabindex;

value

value: any

value 属性を設定または取得します。

例

<igx-checkbox [value]="'CheckboxValue'"></igx-checkbox>

let value =  this.checkbox.value;

アクセサー

checked

nativeElement

required