Ignite UI for Angular

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

Class IgxDialogComponent

Ignite UI for Angular Dialog Window - ヘルプ

Ignite UI Dialog Window はダイアログ ウィンドウをユーザーに表示します。 簡易なメッセージを表示するか、サインイン フォームなどの複雑なビジュアルを表示できます。 カスタム アクションのために提供される右および左ボタンもあります。

例:

<button type="button" igxButton (click)="form.open()">Show Dialog</button>
<igx-dialog #form title="Sign In" rightButtonLabel="OK">
  <div>
    <igx-input-group>
      <input type="text" igxInput/>
      <label igxLabel>Username</label>
    </igx-input-group>
  </div>
  <div>
    <igx-input-group>
      <input type="password" igxInput/>
      <label igxLabel>Password</label>
    </igx-input-group>
  </div>
</igx-dialog>

実装

コンストラクター

プロパティ

アクセサー

メソッド

コンストラクター

constructor

プロパティ

closed

closed: EventEmitter<IDialogEventArgs> = ...

ダイアログが閉じた後に発生されるイベントです。

<igx-dialog (closed)="onDialogClosedHandler($event)" title="Confirmation" leftButtonLabel="Cancel" rightButtonLabel="OK">
</igx-dialog>

closing

closing: EventEmitter<IDialogCancellableEventArgs> = ...

ダイアログが閉じる前に発生されるイベントです。

<igx-dialog (closing)="onDialogCloseHandler($event)" title="Confirmation" leftButtonLabel="Cancel" rightButtonLabel="OK">
</igx-dialog>

focusTrap

focusTrap: boolean = true

ダイアログを開いたときに、Tab キーによるフォーカス移動をダイアログ内に留めるかどうかを設定します。 デフォルトは true です。

<igx-dialog focusTrap="false""></igx-dialog>

id

id: string = ...

id 属性の値を設定します。 提供されていない場合は、自動的に生成されます。```html <igx-dialog [id]="'igx-dialog-56'" #alert title="Notification" leftButtonLabel="OK" (leftButtonSelect)="alert.close()">

leftButtonLabel

leftButtonLabel: string = ''

ダイアログの左ボタンの label を設定します。

<igx-dialog leftButtonLabel="OKAY" #alert title="Notification"  (leftButtonSelect)="alert.close()"></igx-dialog>

leftButtonRipple

leftButtonRipple: string = ''

左ボタンの ripple を設定します。ripple はコンポーネントのクリック/タップをフェードするウェーブのシリーズとしてアニメーションを再生します。 プロパティをすべての有効な CSS 色プロパティ値に設定できます。

<igx-dialog leftButtonRipple="green" leftButtonLabel="OKAY" #alert (leftButtonSelect)="alert.close()"></igx-dialog>

leftButtonSelect

leftButtonSelect: EventEmitter<IDialogEventArgs> = ...

左ボタンがクリックしたときに発生されるイベントです。

<igx-dialog (leftButtonSelect)="onDialogOKSelected($event)" #dialog leftButtonLabel="OK" rightButtonLabel="Cancel">
</igx-dialog>

leftButtonType

leftButtonType: IgxButtonType = 'flat'

左ボタンの type を設定します。有効な値は flat、raised および fab です。 flat タイプのボタンは長方形で影なし。
raised タイプボタンは長方形で影あり。
fab タイプ ボタンは円形で影あり。
デフォルト値は flat です。

<igx-dialog leftButtonType="contained" leftButtonLabel="OKAY" #alert (leftButtonSelect)="alert.close()"></igx-dialog>

message

message: string = ''

ダイアログのメッセージ テキストを設定します。

<igx-dialog message="Your email was sent!" #alert leftButtonLabel="OK" (leftButtonSelect)="alert.close()"></igx-dialog>

opened

opened: EventEmitter<IDialogEventArgs> = ...

ダイアログが開いた後に発生されるイベントです。

<igx-dialog (opened)="onDialogOpenedHandler($event)" (leftButtonSelect)="dialog.close()" rightButtonLabel="OK">
</igx-dialog>

opening

opening: EventEmitter<IDialogCancellableEventArgs> = ...

ダイアログが開く前に発生されるイベントです。

<igx-dialog (opening)="onDialogOpenHandler($event)" (leftButtonSelect)="dialog.close()" rightButtonLabel="OK">
</igx-dialog>

rightButtonLabel

rightButtonLabel: string = ''

ダイアログの右ボタンの label を設定します。

<igx-dialog rightButtonLabel="OKAY" #alert title="Notification"  (leftButtonSelect)="alert.close()"></igx-dialog>

rightButtonRipple

rightButtonRipple: string = ''

右ボタンの ripple を設定します。

<igx-dialog rightButtonRipple="green" rightButtonLabel="OKAY" #alert (leftButtonSelect)="alert.close()"></igx-dialog>

rightButtonSelect

rightButtonSelect: EventEmitter<IDialogEventArgs> = ...

右ボタンがクリックしたときに発生されるイベントです。

<igx-dialog (rightButtonSelect)="onDialogOKSelected($event)"
#dialog title="Confirmation" (leftButtonSelect)="dialog.close()" rightButtonLabel="OK"
rightButtonRipple="#4CAF50" closeOnOutsideSelect="true">
</igx-dialog>

rightButtonType

rightButtonType: IgxButtonType = 'flat'

右ボタンの type を設定します。有効な値は flat、raised および fab です。 flat タイプのボタンは長方形で影なし。
contained タイプボタンは長方形で影あり。
fab タイプ ボタンは円形で影あり。
デフォルト値は flat です。

<igx-dialog rightButtonType="fab" rightButtonLabel="OKAY" #alert (leftButtonSelect)="alert.close()"></igx-dialog>

title

title: string = ''

ダイアログのタイトルを設定します。

<igx-dialog title="Notification" #alert leftButtonLabel="OK" (leftButtonSelect)="alert.close()"></igx-dialog>

toggleRef

toggleRef: IgxToggleDirective

アクセサー

closeOnEscape

closeOnOutsideSelect

  • get closeOnOutsideSelect(): boolean

  • コンポーネントの外側をクリックしたときにダイアログを閉じるかどうかを取得または設定します。デフォルトで false です。

    <igx-dialog closeOnOutsideSelect="true" leftButtonLabel="Cancel" (leftButtonSelect)="dialog.close()"
    rightButtonLabel="OK" rightButtonRipple="#4CAF50" (rightButtonSelect)="onDialogOKSelected($event)">
    </igx-dialog>

    返却 boolean

  • set closeOnOutsideSelect(val): void

  • パラメーター

    • val: boolean

    返却 void

isCollapsed

isModal

isOpen

positionSettings

  • get positionSettings(): PositionSettings

  • ダイアログで使用される位置とアニメーション設定を取得します。

    @ViewChild('alert', { static: true }) public alert: IgxDialogComponent;
    let currentPosition: PositionSettings = this.alert.positionSettings

    返却 PositionSettings

  • set positionSettings(settings): void

  • ダイアログで使用される位置とアニメーション設定を設定します。

    import { slideInLeft, slideOutRight } from 'igniteui-angular';
    ...
    @ViewChild('alert', { static: true }) public alert: IgxDialogComponent;
     public newPositionSettings: PositionSettings = {
         openAnimation: useAnimation(slideInTop, { params: { duration: '2000ms' } }),
         closeAnimation: useAnimation(slideOutBottom, { params: { duration: '2000ms'} }),
         horizontalDirection: HorizontalAlignment.Left,
         verticalDirection: VerticalAlignment.Middle,
         horizontalStartPoint: HorizontalAlignment.Left,
         verticalStartPoint: VerticalAlignment.Middle,
         minSize: { height: 100, width: 100 }
     };
    this.alert.positionSettings = this.newPositionSettings;

    パラメーター

    返却 void

role

  • get role(): "dialog" | "alertdialog" | "alert"

  • ダイアログのロールの値を返します。T有効な値は dialog、alertdialog、または alert です。

    @ViewChild("MyDialog")
    public dialog: IgxDialogComponent;
    ngAfterViewInit() {
        let dialogRole = this.dialog.role;
    }

    返却 "dialog" | "alertdialog" | "alert"

state

  • get state(): string

  • 状態の値を返します。利用可能な状態値は "open" または "close" です。

    @ViewChild("MyDialog")
    public dialog: IgxDialogComponent;
    ngAfterViewInit() {
        let dialogState = this.dialog.state;
    }

    返却 string

titleId

メソッド

close

ngAfterContentInit

  • ngAfterContentInit(): void

  • Angular がディレクティブのすべてのコンテンツの初期化を完了した直後に呼び出されるコールバック メソッド。ディレクティブがインスタンス化されるときに 1 回だけ呼び出されます。

    返却 void

open

toggle