@openremote/or-vaadin-components 1.25.0 → 1.26.0-snapshot.20260618150807
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements-jsx.d.ts +448 -448
- package/custom-elements.json +2689 -2689
- package/package.json +3 -3
package/custom-elements-jsx.d.ts
CHANGED
|
@@ -68,8 +68,8 @@ import type { MultiSelectComboBoxItem } from "/home/runner/work/openremote/openr
|
|
|
68
68
|
import type { MultiSelectComboBoxScroller } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/multi-select-combo-box/./lib/vaadin-multi-select-combo-box-scroller.js";
|
|
69
69
|
import type { MultiSelectComboBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/multi-select-combo-box/./lib/vaadin-multi-select-combo-box.js";
|
|
70
70
|
import type { NumberField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/number-field/./lib/vaadin-number-field.js";
|
|
71
|
-
import type { Overlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/overlay/./lib/vaadin-overlay.js";
|
|
72
71
|
import type { PasswordField } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/password-field/./lib/vaadin-password-field.js";
|
|
72
|
+
import type { Overlay } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/overlay/./lib/vaadin-overlay.js";
|
|
73
73
|
import type { RadioButton } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/radio-group/./lib/vaadin-radio-button.js";
|
|
74
74
|
import type { RadioGroup } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/radio-group/./lib/vaadin-radio-group.js";
|
|
75
75
|
import type { SelectListBox } from "/home/runner/work/openremote/openremote/node_modules/@vaadin/select/./lib/vaadin-select-list-box.js";
|
|
@@ -8341,144 +8341,6 @@ the clear icon element should be provided via the `clearElement` getter. */
|
|
|
8341
8341
|
textContent?: string | number;
|
|
8342
8342
|
};
|
|
8343
8343
|
|
|
8344
|
-
export type OverlayProps = {
|
|
8345
|
-
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8346
|
-
opening?: unknown;
|
|
8347
|
-
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8348
|
-
undefined?: unknown;
|
|
8349
|
-
/** Applied just before the overlay is closed. You can apply a CSS animation for this state. */
|
|
8350
|
-
closing?: unknown;
|
|
8351
|
-
/** When true, the overlay is visible and attached to body. */
|
|
8352
|
-
opened?: Overlay["opened"];
|
|
8353
|
-
/** Owner element passed with renderer function */
|
|
8354
|
-
owner?: Overlay["owner"];
|
|
8355
|
-
/** Object with properties that is passed to `renderer` function */
|
|
8356
|
-
model?: Overlay["model"];
|
|
8357
|
-
/** Custom function for rendering the content of the overlay.
|
|
8358
|
-
Receives three arguments:
|
|
8359
|
-
|
|
8360
|
-
- `root` The root container DOM element. Append your content to it.
|
|
8361
|
-
- `owner` The host element of the renderer function.
|
|
8362
|
-
- `model` The object with the properties related with rendering. */
|
|
8363
|
-
renderer?: Overlay["renderer"];
|
|
8364
|
-
/** When true the overlay won't disable the main content, showing
|
|
8365
|
-
it doesn't change the functionality of the user interface. */
|
|
8366
|
-
modeless?: Overlay["modeless"];
|
|
8367
|
-
/** When set to true, the overlay is hidden. This also closes the overlay
|
|
8368
|
-
immediately in case there is a closing animation in progress. */
|
|
8369
|
-
hidden?: Overlay["hidden"];
|
|
8370
|
-
/** When true the overlay has backdrop on top of content when opened. */
|
|
8371
|
-
withBackdrop?: Overlay["withBackdrop"];
|
|
8372
|
-
/** When true, opening the overlay moves focus to the first focusable child,
|
|
8373
|
-
or to the overlay part with tabindex if there are no focusable children. */
|
|
8374
|
-
focusTrap?: Overlay["focusTrap"];
|
|
8375
|
-
/** Set to true to enable restoring of focus when overlay is closed. */
|
|
8376
|
-
restoreFocusOnClose?: Overlay["restoreFocusOnClose"];
|
|
8377
|
-
/** Set to specify the element which should be focused on overlay close,
|
|
8378
|
-
if `restoreFocusOnClose` is set to true. */
|
|
8379
|
-
restoreFocusNode?: Overlay["restoreFocusNode"];
|
|
8380
|
-
/** */
|
|
8381
|
-
dir?: Overlay["dir"];
|
|
8382
|
-
/** */
|
|
8383
|
-
_boundMouseDownListener?: Overlay["_boundMouseDownListener"];
|
|
8384
|
-
/** */
|
|
8385
|
-
_boundMouseUpListener?: Overlay["_boundMouseUpListener"];
|
|
8386
|
-
/** */
|
|
8387
|
-
_boundOutsideClickListener?: Overlay["_boundOutsideClickListener"];
|
|
8388
|
-
/** */
|
|
8389
|
-
_boundKeydownListener?: Overlay["_boundKeydownListener"];
|
|
8390
|
-
/** */
|
|
8391
|
-
__focusTrapController?: Overlay["__focusTrapController"];
|
|
8392
|
-
/** */
|
|
8393
|
-
__focusRestorationController?: Overlay["__focusRestorationController"];
|
|
8394
|
-
|
|
8395
|
-
/** Fired when the `opened` property changes. */
|
|
8396
|
-
"onopened-changed"?: (e: CustomEvent) => void;
|
|
8397
|
-
/** Fired after the overlay is opened. */
|
|
8398
|
-
"onvaadin-overlay-open"?: (e: CustomEvent) => void;
|
|
8399
|
-
/** Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing. */
|
|
8400
|
-
"onvaadin-overlay-close"?: (e: CustomEvent) => void;
|
|
8401
|
-
/** Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation. */
|
|
8402
|
-
"onvaadin-overlay-closing"?: (e: CustomEvent) => void;
|
|
8403
|
-
/** Fired after the overlay is closed. */
|
|
8404
|
-
"onvaadin-overlay-closed"?: (e: CustomEvent) => void;
|
|
8405
|
-
/** Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing. */
|
|
8406
|
-
"onvaadin-overlay-outside-click"?: (e: CustomEvent) => void;
|
|
8407
|
-
/** Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing. */
|
|
8408
|
-
"onvaadin-overlay-escape-press"?: (e: CustomEvent) => void;
|
|
8409
|
-
};
|
|
8410
|
-
|
|
8411
|
-
export type OverlaySolidJsProps = {
|
|
8412
|
-
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8413
|
-
"bool:opening"?: unknown;
|
|
8414
|
-
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8415
|
-
"prop:undefined"?: unknown;
|
|
8416
|
-
/** Applied just before the overlay is closed. You can apply a CSS animation for this state. */
|
|
8417
|
-
"bool:closing"?: unknown;
|
|
8418
|
-
/** When true, the overlay is visible and attached to body. */
|
|
8419
|
-
"prop:opened"?: Overlay["opened"];
|
|
8420
|
-
/** Owner element passed with renderer function */
|
|
8421
|
-
"prop:owner"?: Overlay["owner"];
|
|
8422
|
-
/** Object with properties that is passed to `renderer` function */
|
|
8423
|
-
"prop:model"?: Overlay["model"];
|
|
8424
|
-
/** Custom function for rendering the content of the overlay.
|
|
8425
|
-
Receives three arguments:
|
|
8426
|
-
|
|
8427
|
-
- `root` The root container DOM element. Append your content to it.
|
|
8428
|
-
- `owner` The host element of the renderer function.
|
|
8429
|
-
- `model` The object with the properties related with rendering. */
|
|
8430
|
-
"prop:renderer"?: Overlay["renderer"];
|
|
8431
|
-
/** When true the overlay won't disable the main content, showing
|
|
8432
|
-
it doesn't change the functionality of the user interface. */
|
|
8433
|
-
"prop:modeless"?: Overlay["modeless"];
|
|
8434
|
-
/** When set to true, the overlay is hidden. This also closes the overlay
|
|
8435
|
-
immediately in case there is a closing animation in progress. */
|
|
8436
|
-
"prop:hidden"?: Overlay["hidden"];
|
|
8437
|
-
/** When true the overlay has backdrop on top of content when opened. */
|
|
8438
|
-
"prop:withBackdrop"?: Overlay["withBackdrop"];
|
|
8439
|
-
/** When true, opening the overlay moves focus to the first focusable child,
|
|
8440
|
-
or to the overlay part with tabindex if there are no focusable children. */
|
|
8441
|
-
"prop:focusTrap"?: Overlay["focusTrap"];
|
|
8442
|
-
/** Set to true to enable restoring of focus when overlay is closed. */
|
|
8443
|
-
"prop:restoreFocusOnClose"?: Overlay["restoreFocusOnClose"];
|
|
8444
|
-
/** Set to specify the element which should be focused on overlay close,
|
|
8445
|
-
if `restoreFocusOnClose` is set to true. */
|
|
8446
|
-
"prop:restoreFocusNode"?: Overlay["restoreFocusNode"];
|
|
8447
|
-
/** */
|
|
8448
|
-
"prop:dir"?: Overlay["dir"];
|
|
8449
|
-
/** */
|
|
8450
|
-
"prop:_boundMouseDownListener"?: Overlay["_boundMouseDownListener"];
|
|
8451
|
-
/** */
|
|
8452
|
-
"prop:_boundMouseUpListener"?: Overlay["_boundMouseUpListener"];
|
|
8453
|
-
/** */
|
|
8454
|
-
"prop:_boundOutsideClickListener"?: Overlay["_boundOutsideClickListener"];
|
|
8455
|
-
/** */
|
|
8456
|
-
"prop:_boundKeydownListener"?: Overlay["_boundKeydownListener"];
|
|
8457
|
-
/** */
|
|
8458
|
-
"prop:__focusTrapController"?: Overlay["__focusTrapController"];
|
|
8459
|
-
/** */
|
|
8460
|
-
"prop:__focusRestorationController"?: Overlay["__focusRestorationController"];
|
|
8461
|
-
/** Fired when the `opened` property changes. */
|
|
8462
|
-
"on:opened-changed"?: (e: CustomEvent) => void;
|
|
8463
|
-
/** Fired after the overlay is opened. */
|
|
8464
|
-
"on:vaadin-overlay-open"?: (e: CustomEvent) => void;
|
|
8465
|
-
/** Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing. */
|
|
8466
|
-
"on:vaadin-overlay-close"?: (e: CustomEvent) => void;
|
|
8467
|
-
/** Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation. */
|
|
8468
|
-
"on:vaadin-overlay-closing"?: (e: CustomEvent) => void;
|
|
8469
|
-
/** Fired after the overlay is closed. */
|
|
8470
|
-
"on:vaadin-overlay-closed"?: (e: CustomEvent) => void;
|
|
8471
|
-
/** Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing. */
|
|
8472
|
-
"on:vaadin-overlay-outside-click"?: (e: CustomEvent) => void;
|
|
8473
|
-
/** Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing. */
|
|
8474
|
-
"on:vaadin-overlay-escape-press"?: (e: CustomEvent) => void;
|
|
8475
|
-
|
|
8476
|
-
/** Set the innerHTML of the element */
|
|
8477
|
-
innerHTML?: string;
|
|
8478
|
-
/** Set the textContent of the element */
|
|
8479
|
-
textContent?: string | number;
|
|
8480
|
-
};
|
|
8481
|
-
|
|
8482
8344
|
export type PasswordFieldProps = {
|
|
8483
8345
|
/** Set when the element is disabled */
|
|
8484
8346
|
disabled?: unknown;
|
|
@@ -8733,77 +8595,215 @@ the clear icon element should be provided via the `clearElement` getter. */
|
|
|
8733
8595
|
textContent?: string | number;
|
|
8734
8596
|
};
|
|
8735
8597
|
|
|
8736
|
-
export type
|
|
8737
|
-
/**
|
|
8738
|
-
|
|
8739
|
-
/**
|
|
8598
|
+
export type OverlayProps = {
|
|
8599
|
+
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8600
|
+
opening?: unknown;
|
|
8601
|
+
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8740
8602
|
undefined?: unknown;
|
|
8741
|
-
/**
|
|
8742
|
-
|
|
8743
|
-
/**
|
|
8744
|
-
"
|
|
8745
|
-
/**
|
|
8746
|
-
|
|
8747
|
-
/**
|
|
8748
|
-
|
|
8749
|
-
/**
|
|
8750
|
-
|
|
8751
|
-
|
|
8752
|
-
|
|
8753
|
-
|
|
8754
|
-
|
|
8755
|
-
|
|
8756
|
-
/**
|
|
8757
|
-
|
|
8603
|
+
/** Applied just before the overlay is closed. You can apply a CSS animation for this state. */
|
|
8604
|
+
closing?: unknown;
|
|
8605
|
+
/** When true, the overlay is visible and attached to body. */
|
|
8606
|
+
opened?: Overlay["opened"];
|
|
8607
|
+
/** Owner element passed with renderer function */
|
|
8608
|
+
owner?: Overlay["owner"];
|
|
8609
|
+
/** Object with properties that is passed to `renderer` function */
|
|
8610
|
+
model?: Overlay["model"];
|
|
8611
|
+
/** Custom function for rendering the content of the overlay.
|
|
8612
|
+
Receives three arguments:
|
|
8613
|
+
|
|
8614
|
+
- `root` The root container DOM element. Append your content to it.
|
|
8615
|
+
- `owner` The host element of the renderer function.
|
|
8616
|
+
- `model` The object with the properties related with rendering. */
|
|
8617
|
+
renderer?: Overlay["renderer"];
|
|
8618
|
+
/** When true the overlay won't disable the main content, showing
|
|
8619
|
+
it doesn't change the functionality of the user interface. */
|
|
8620
|
+
modeless?: Overlay["modeless"];
|
|
8621
|
+
/** When set to true, the overlay is hidden. This also closes the overlay
|
|
8622
|
+
immediately in case there is a closing animation in progress. */
|
|
8623
|
+
hidden?: Overlay["hidden"];
|
|
8624
|
+
/** When true the overlay has backdrop on top of content when opened. */
|
|
8625
|
+
withBackdrop?: Overlay["withBackdrop"];
|
|
8626
|
+
/** When true, opening the overlay moves focus to the first focusable child,
|
|
8627
|
+
or to the overlay part with tabindex if there are no focusable children. */
|
|
8628
|
+
focusTrap?: Overlay["focusTrap"];
|
|
8629
|
+
/** Set to true to enable restoring of focus when overlay is closed. */
|
|
8630
|
+
restoreFocusOnClose?: Overlay["restoreFocusOnClose"];
|
|
8631
|
+
/** Set to specify the element which should be focused on overlay close,
|
|
8632
|
+
if `restoreFocusOnClose` is set to true. */
|
|
8633
|
+
restoreFocusNode?: Overlay["restoreFocusNode"];
|
|
8758
8634
|
/** */
|
|
8759
|
-
|
|
8635
|
+
dir?: Overlay["dir"];
|
|
8760
8636
|
/** */
|
|
8761
|
-
|
|
8637
|
+
_boundMouseDownListener?: Overlay["_boundMouseDownListener"];
|
|
8762
8638
|
/** */
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
/** Fired when the `checked` property changes. */
|
|
8766
|
-
"onchecked-changed"?: (e: CustomEvent) => void;
|
|
8767
|
-
};
|
|
8768
|
-
|
|
8769
|
-
export type RadioButtonSolidJsProps = {
|
|
8770
|
-
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8771
|
-
"bool:active"?: unknown;
|
|
8772
|
-
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8773
|
-
"prop:undefined"?: unknown;
|
|
8774
|
-
/** Set when the radio button is disabled. */
|
|
8775
|
-
"bool:disabled"?: unknown;
|
|
8776
|
-
/** Set when the radio button is focused using the keyboard. */
|
|
8777
|
-
"bool:focus-ring"?: unknown;
|
|
8778
|
-
/** Set when the radio button is focused. */
|
|
8779
|
-
"bool:focused"?: unknown;
|
|
8780
|
-
/** Set when the radio button is checked. */
|
|
8781
|
-
"prop:checked"?: RadioButton["checked"];
|
|
8782
|
-
/** Set when the radio button has a label. */
|
|
8783
|
-
"bool:has-label"?: unknown;
|
|
8784
|
-
/** The name of the radio button. */
|
|
8785
|
-
"prop:name"?: RadioButton["name"];
|
|
8786
|
-
/** The label text for the input node.
|
|
8787
|
-
When no light dom defined via [slot=label], this value will be used. */
|
|
8788
|
-
"prop:label"?: RadioButton["label"];
|
|
8639
|
+
_boundMouseUpListener?: Overlay["_boundMouseUpListener"];
|
|
8789
8640
|
/** */
|
|
8790
|
-
|
|
8641
|
+
_boundOutsideClickListener?: Overlay["_boundOutsideClickListener"];
|
|
8791
8642
|
/** */
|
|
8792
|
-
|
|
8643
|
+
_boundKeydownListener?: Overlay["_boundKeydownListener"];
|
|
8793
8644
|
/** */
|
|
8794
|
-
|
|
8645
|
+
__focusTrapController?: Overlay["__focusTrapController"];
|
|
8795
8646
|
/** */
|
|
8796
|
-
|
|
8797
|
-
/** Fired when the `checked` property changes. */
|
|
8798
|
-
"on:checked-changed"?: (e: CustomEvent) => void;
|
|
8647
|
+
__focusRestorationController?: Overlay["__focusRestorationController"];
|
|
8799
8648
|
|
|
8800
|
-
/**
|
|
8801
|
-
|
|
8802
|
-
/**
|
|
8803
|
-
|
|
8649
|
+
/** Fired when the `opened` property changes. */
|
|
8650
|
+
"onopened-changed"?: (e: CustomEvent) => void;
|
|
8651
|
+
/** Fired after the overlay is opened. */
|
|
8652
|
+
"onvaadin-overlay-open"?: (e: CustomEvent) => void;
|
|
8653
|
+
/** Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing. */
|
|
8654
|
+
"onvaadin-overlay-close"?: (e: CustomEvent) => void;
|
|
8655
|
+
/** Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation. */
|
|
8656
|
+
"onvaadin-overlay-closing"?: (e: CustomEvent) => void;
|
|
8657
|
+
/** Fired after the overlay is closed. */
|
|
8658
|
+
"onvaadin-overlay-closed"?: (e: CustomEvent) => void;
|
|
8659
|
+
/** Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing. */
|
|
8660
|
+
"onvaadin-overlay-outside-click"?: (e: CustomEvent) => void;
|
|
8661
|
+
/** Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing. */
|
|
8662
|
+
"onvaadin-overlay-escape-press"?: (e: CustomEvent) => void;
|
|
8804
8663
|
};
|
|
8805
8664
|
|
|
8806
|
-
export type
|
|
8665
|
+
export type OverlaySolidJsProps = {
|
|
8666
|
+
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8667
|
+
"bool:opening"?: unknown;
|
|
8668
|
+
/** Applied just after the overlay is opened. You can apply a CSS animation for this state. */
|
|
8669
|
+
"prop:undefined"?: unknown;
|
|
8670
|
+
/** Applied just before the overlay is closed. You can apply a CSS animation for this state. */
|
|
8671
|
+
"bool:closing"?: unknown;
|
|
8672
|
+
/** When true, the overlay is visible and attached to body. */
|
|
8673
|
+
"prop:opened"?: Overlay["opened"];
|
|
8674
|
+
/** Owner element passed with renderer function */
|
|
8675
|
+
"prop:owner"?: Overlay["owner"];
|
|
8676
|
+
/** Object with properties that is passed to `renderer` function */
|
|
8677
|
+
"prop:model"?: Overlay["model"];
|
|
8678
|
+
/** Custom function for rendering the content of the overlay.
|
|
8679
|
+
Receives three arguments:
|
|
8680
|
+
|
|
8681
|
+
- `root` The root container DOM element. Append your content to it.
|
|
8682
|
+
- `owner` The host element of the renderer function.
|
|
8683
|
+
- `model` The object with the properties related with rendering. */
|
|
8684
|
+
"prop:renderer"?: Overlay["renderer"];
|
|
8685
|
+
/** When true the overlay won't disable the main content, showing
|
|
8686
|
+
it doesn't change the functionality of the user interface. */
|
|
8687
|
+
"prop:modeless"?: Overlay["modeless"];
|
|
8688
|
+
/** When set to true, the overlay is hidden. This also closes the overlay
|
|
8689
|
+
immediately in case there is a closing animation in progress. */
|
|
8690
|
+
"prop:hidden"?: Overlay["hidden"];
|
|
8691
|
+
/** When true the overlay has backdrop on top of content when opened. */
|
|
8692
|
+
"prop:withBackdrop"?: Overlay["withBackdrop"];
|
|
8693
|
+
/** When true, opening the overlay moves focus to the first focusable child,
|
|
8694
|
+
or to the overlay part with tabindex if there are no focusable children. */
|
|
8695
|
+
"prop:focusTrap"?: Overlay["focusTrap"];
|
|
8696
|
+
/** Set to true to enable restoring of focus when overlay is closed. */
|
|
8697
|
+
"prop:restoreFocusOnClose"?: Overlay["restoreFocusOnClose"];
|
|
8698
|
+
/** Set to specify the element which should be focused on overlay close,
|
|
8699
|
+
if `restoreFocusOnClose` is set to true. */
|
|
8700
|
+
"prop:restoreFocusNode"?: Overlay["restoreFocusNode"];
|
|
8701
|
+
/** */
|
|
8702
|
+
"prop:dir"?: Overlay["dir"];
|
|
8703
|
+
/** */
|
|
8704
|
+
"prop:_boundMouseDownListener"?: Overlay["_boundMouseDownListener"];
|
|
8705
|
+
/** */
|
|
8706
|
+
"prop:_boundMouseUpListener"?: Overlay["_boundMouseUpListener"];
|
|
8707
|
+
/** */
|
|
8708
|
+
"prop:_boundOutsideClickListener"?: Overlay["_boundOutsideClickListener"];
|
|
8709
|
+
/** */
|
|
8710
|
+
"prop:_boundKeydownListener"?: Overlay["_boundKeydownListener"];
|
|
8711
|
+
/** */
|
|
8712
|
+
"prop:__focusTrapController"?: Overlay["__focusTrapController"];
|
|
8713
|
+
/** */
|
|
8714
|
+
"prop:__focusRestorationController"?: Overlay["__focusRestorationController"];
|
|
8715
|
+
/** Fired when the `opened` property changes. */
|
|
8716
|
+
"on:opened-changed"?: (e: CustomEvent) => void;
|
|
8717
|
+
/** Fired after the overlay is opened. */
|
|
8718
|
+
"on:vaadin-overlay-open"?: (e: CustomEvent) => void;
|
|
8719
|
+
/** Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing. */
|
|
8720
|
+
"on:vaadin-overlay-close"?: (e: CustomEvent) => void;
|
|
8721
|
+
/** Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation. */
|
|
8722
|
+
"on:vaadin-overlay-closing"?: (e: CustomEvent) => void;
|
|
8723
|
+
/** Fired after the overlay is closed. */
|
|
8724
|
+
"on:vaadin-overlay-closed"?: (e: CustomEvent) => void;
|
|
8725
|
+
/** Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing. */
|
|
8726
|
+
"on:vaadin-overlay-outside-click"?: (e: CustomEvent) => void;
|
|
8727
|
+
/** Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing. */
|
|
8728
|
+
"on:vaadin-overlay-escape-press"?: (e: CustomEvent) => void;
|
|
8729
|
+
|
|
8730
|
+
/** Set the innerHTML of the element */
|
|
8731
|
+
innerHTML?: string;
|
|
8732
|
+
/** Set the textContent of the element */
|
|
8733
|
+
textContent?: string | number;
|
|
8734
|
+
};
|
|
8735
|
+
|
|
8736
|
+
export type RadioButtonProps = {
|
|
8737
|
+
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8738
|
+
active?: unknown;
|
|
8739
|
+
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8740
|
+
undefined?: unknown;
|
|
8741
|
+
/** Set when the radio button is disabled. */
|
|
8742
|
+
disabled?: unknown;
|
|
8743
|
+
/** Set when the radio button is focused using the keyboard. */
|
|
8744
|
+
"focus-ring"?: unknown;
|
|
8745
|
+
/** Set when the radio button is focused. */
|
|
8746
|
+
focused?: unknown;
|
|
8747
|
+
/** Set when the radio button is checked. */
|
|
8748
|
+
checked?: RadioButton["checked"];
|
|
8749
|
+
/** Set when the radio button has a label. */
|
|
8750
|
+
"has-label"?: unknown;
|
|
8751
|
+
/** The name of the radio button. */
|
|
8752
|
+
name?: RadioButton["name"];
|
|
8753
|
+
/** The label text for the input node.
|
|
8754
|
+
When no light dom defined via [slot=label], this value will be used. */
|
|
8755
|
+
label?: RadioButton["label"];
|
|
8756
|
+
/** */
|
|
8757
|
+
dir?: RadioButton["dir"];
|
|
8758
|
+
/** */
|
|
8759
|
+
value?: RadioButton["value"];
|
|
8760
|
+
/** */
|
|
8761
|
+
tabindex?: RadioButton["tabindex"];
|
|
8762
|
+
/** */
|
|
8763
|
+
_labelController?: RadioButton["_labelController"];
|
|
8764
|
+
|
|
8765
|
+
/** Fired when the `checked` property changes. */
|
|
8766
|
+
"onchecked-changed"?: (e: CustomEvent) => void;
|
|
8767
|
+
};
|
|
8768
|
+
|
|
8769
|
+
export type RadioButtonSolidJsProps = {
|
|
8770
|
+
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8771
|
+
"bool:active"?: unknown;
|
|
8772
|
+
/** Set when the radio button is pressed, either with a pointer or the keyboard. */
|
|
8773
|
+
"prop:undefined"?: unknown;
|
|
8774
|
+
/** Set when the radio button is disabled. */
|
|
8775
|
+
"bool:disabled"?: unknown;
|
|
8776
|
+
/** Set when the radio button is focused using the keyboard. */
|
|
8777
|
+
"bool:focus-ring"?: unknown;
|
|
8778
|
+
/** Set when the radio button is focused. */
|
|
8779
|
+
"bool:focused"?: unknown;
|
|
8780
|
+
/** Set when the radio button is checked. */
|
|
8781
|
+
"prop:checked"?: RadioButton["checked"];
|
|
8782
|
+
/** Set when the radio button has a label. */
|
|
8783
|
+
"bool:has-label"?: unknown;
|
|
8784
|
+
/** The name of the radio button. */
|
|
8785
|
+
"prop:name"?: RadioButton["name"];
|
|
8786
|
+
/** The label text for the input node.
|
|
8787
|
+
When no light dom defined via [slot=label], this value will be used. */
|
|
8788
|
+
"prop:label"?: RadioButton["label"];
|
|
8789
|
+
/** */
|
|
8790
|
+
"prop:dir"?: RadioButton["dir"];
|
|
8791
|
+
/** */
|
|
8792
|
+
"prop:value"?: RadioButton["value"];
|
|
8793
|
+
/** */
|
|
8794
|
+
"prop:tabindex"?: RadioButton["tabindex"];
|
|
8795
|
+
/** */
|
|
8796
|
+
"prop:_labelController"?: RadioButton["_labelController"];
|
|
8797
|
+
/** Fired when the `checked` property changes. */
|
|
8798
|
+
"on:checked-changed"?: (e: CustomEvent) => void;
|
|
8799
|
+
|
|
8800
|
+
/** Set the innerHTML of the element */
|
|
8801
|
+
innerHTML?: string;
|
|
8802
|
+
/** Set the textContent of the element */
|
|
8803
|
+
textContent?: string | number;
|
|
8804
|
+
};
|
|
8805
|
+
|
|
8806
|
+
export type RadioGroupProps = {
|
|
8807
8807
|
/** Set when the element is disabled */
|
|
8808
8808
|
disabled?: unknown;
|
|
8809
8809
|
/** Set when the element is disabled */
|
|
@@ -16093,128 +16093,6 @@ export type CustomElements = {
|
|
|
16093
16093
|
NumberFieldProps & BaseProps<NumberField> & BaseEvents
|
|
16094
16094
|
>;
|
|
16095
16095
|
|
|
16096
|
-
/**
|
|
16097
|
-
* `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
|
|
16098
|
-
* can be populated imperatively by using `renderer` callback function.
|
|
16099
|
-
*
|
|
16100
|
-
* ### Rendering
|
|
16101
|
-
*
|
|
16102
|
-
* The renderer function provides `root`, `owner`, `model` arguments when applicable.
|
|
16103
|
-
* Generate DOM content by using `model` object properties if needed, append it to the `root`
|
|
16104
|
-
* element and control the state of the host element by accessing `owner`. Before generating new
|
|
16105
|
-
* content, users are able to check if there is already content in `root` for reusing it.
|
|
16106
|
-
*
|
|
16107
|
-
* ```html
|
|
16108
|
-
* <vaadin-overlay id="overlay"></vaadin-overlay>
|
|
16109
|
-
* ```
|
|
16110
|
-
* ```js
|
|
16111
|
-
* const overlay = document.querySelector('#overlay');
|
|
16112
|
-
* overlay.renderer = function(root) {
|
|
16113
|
-
* root.textContent = "Overlay content";
|
|
16114
|
-
* };
|
|
16115
|
-
* ```
|
|
16116
|
-
*
|
|
16117
|
-
* Renderer is called on the opening of the overlay and each time the related model is updated.
|
|
16118
|
-
* DOM generated during the renderer call can be reused
|
|
16119
|
-
* in the next renderer call and will be provided with the `root` argument.
|
|
16120
|
-
* On first call it will be empty.
|
|
16121
|
-
*
|
|
16122
|
-
* ### Styling
|
|
16123
|
-
*
|
|
16124
|
-
* The following Shadow DOM parts are available for styling:
|
|
16125
|
-
*
|
|
16126
|
-
* Part name | Description
|
|
16127
|
-
* -----------|---------------------------------------------------------|
|
|
16128
|
-
* `backdrop` | Backdrop of the overlay
|
|
16129
|
-
* `overlay` | Container for position/sizing/alignment of the content
|
|
16130
|
-
* `content` | Content of the overlay
|
|
16131
|
-
*
|
|
16132
|
-
* The following state attributes are available for styling:
|
|
16133
|
-
*
|
|
16134
|
-
* Attribute | Description
|
|
16135
|
-
* ----------|------------
|
|
16136
|
-
* `opening` | Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
16137
|
-
* `closing` | Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
16138
|
-
*
|
|
16139
|
-
* The following custom CSS properties are available for styling:
|
|
16140
|
-
*
|
|
16141
|
-
* Custom CSS property | Description | Default value
|
|
16142
|
-
* ---|---|---
|
|
16143
|
-
* `--vaadin-overlay-viewport-bottom` | Bottom offset of the visible viewport area | `0` or detected offset
|
|
16144
|
-
*
|
|
16145
|
-
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
|
|
16146
|
-
*
|
|
16147
|
-
* ## Attributes & Properties
|
|
16148
|
-
*
|
|
16149
|
-
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
16150
|
-
*
|
|
16151
|
-
* - `opening`/`undefined`: Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
16152
|
-
* - `closing`/`undefined`: Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
16153
|
-
* - `opened`: When true, the overlay is visible and attached to body.
|
|
16154
|
-
* - `owner`: Owner element passed with renderer function
|
|
16155
|
-
* - `model`: Object with properties that is passed to `renderer` function
|
|
16156
|
-
* - `renderer`: Custom function for rendering the content of the overlay.
|
|
16157
|
-
* Receives three arguments:
|
|
16158
|
-
*
|
|
16159
|
-
* - `root` The root container DOM element. Append your content to it.
|
|
16160
|
-
* - `owner` The host element of the renderer function.
|
|
16161
|
-
* - `model` The object with the properties related with rendering.
|
|
16162
|
-
* - `modeless`: When true the overlay won't disable the main content, showing
|
|
16163
|
-
* it doesn't change the functionality of the user interface.
|
|
16164
|
-
* - `hidden`: When set to true, the overlay is hidden. This also closes the overlay
|
|
16165
|
-
* immediately in case there is a closing animation in progress.
|
|
16166
|
-
* - `withBackdrop`: When true the overlay has backdrop on top of content when opened.
|
|
16167
|
-
* - `focusTrap`: When true, opening the overlay moves focus to the first focusable child,
|
|
16168
|
-
* or to the overlay part with tabindex if there are no focusable children.
|
|
16169
|
-
* - `restoreFocusOnClose`: Set to true to enable restoring of focus when overlay is closed.
|
|
16170
|
-
* - `restoreFocusNode`: Set to specify the element which should be focused on overlay close,
|
|
16171
|
-
* if `restoreFocusOnClose` is set to true.
|
|
16172
|
-
* - `dir`: undefined
|
|
16173
|
-
* - `_boundMouseDownListener`: undefined (property only)
|
|
16174
|
-
* - `_boundMouseUpListener`: undefined (property only)
|
|
16175
|
-
* - `_boundOutsideClickListener`: undefined (property only)
|
|
16176
|
-
* - `_boundKeydownListener`: undefined (property only)
|
|
16177
|
-
* - `__focusTrapController`: undefined (property only)
|
|
16178
|
-
* - `__focusRestorationController`: undefined (property only)
|
|
16179
|
-
*
|
|
16180
|
-
* ## Events
|
|
16181
|
-
*
|
|
16182
|
-
* Events that will be emitted by the component.
|
|
16183
|
-
*
|
|
16184
|
-
* - `opened-changed`: Fired when the `opened` property changes.
|
|
16185
|
-
* - `vaadin-overlay-open`: Fired after the overlay is opened.
|
|
16186
|
-
* - `vaadin-overlay-close`: Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing.
|
|
16187
|
-
* - `vaadin-overlay-closing`: Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation.
|
|
16188
|
-
* - `vaadin-overlay-closed`: Fired after the overlay is closed.
|
|
16189
|
-
* - `vaadin-overlay-outside-click`: Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.
|
|
16190
|
-
* - `vaadin-overlay-escape-press`: Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.
|
|
16191
|
-
* - `undefined`: undefined
|
|
16192
|
-
*
|
|
16193
|
-
* ## Methods
|
|
16194
|
-
*
|
|
16195
|
-
* Methods that can be called to access component functionality.
|
|
16196
|
-
*
|
|
16197
|
-
* - `requestContentUpdate() => void`: Requests an update for the content of the overlay.
|
|
16198
|
-
* While performing the update, it invokes the renderer passed in the `renderer` property.
|
|
16199
|
-
*
|
|
16200
|
-
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
16201
|
-
* - `close(sourceEvent: Event=) => void`: undefined
|
|
16202
|
-
* - `setBounds(bounds: !OverlayBoundsParam, absolute: boolean = true) => void`: Updates the coordinates of the overlay.
|
|
16203
|
-
* - `bringToFront() => void`: Brings the overlay as visually the frontmost one.
|
|
16204
|
-
* - `createProperty(name, options) => void`: undefined
|
|
16205
|
-
* - `getOrCreateMap(name) => void`: undefined
|
|
16206
|
-
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
16207
|
-
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
16208
|
-
*
|
|
16209
|
-
* ## CSS Custom Properties
|
|
16210
|
-
*
|
|
16211
|
-
* CSS variables available for styling the component.
|
|
16212
|
-
*
|
|
16213
|
-
* - `--vaadin-overlay-viewport-bottom`: Bottom offset of the visible viewport area (default: `undefined`)
|
|
16214
|
-
* - `0`: undefined (default: `undefined`)
|
|
16215
|
-
*/
|
|
16216
|
-
"vaadin-overlay": Partial<OverlayProps & BaseProps<Overlay> & BaseEvents>;
|
|
16217
|
-
|
|
16218
16096
|
/**
|
|
16219
16097
|
* `<vaadin-password-field>` is an extension of `<vaadin-text-field>` component for entering passwords.
|
|
16220
16098
|
*
|
|
@@ -16351,9 +16229,131 @@ export type CustomElements = {
|
|
|
16351
16229
|
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
16352
16230
|
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
16353
16231
|
*/
|
|
16354
|
-
"vaadin-password-field": Partial<
|
|
16355
|
-
PasswordFieldProps & BaseProps<PasswordField> & BaseEvents
|
|
16356
|
-
>;
|
|
16232
|
+
"vaadin-password-field": Partial<
|
|
16233
|
+
PasswordFieldProps & BaseProps<PasswordField> & BaseEvents
|
|
16234
|
+
>;
|
|
16235
|
+
|
|
16236
|
+
/**
|
|
16237
|
+
* `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
|
|
16238
|
+
* can be populated imperatively by using `renderer` callback function.
|
|
16239
|
+
*
|
|
16240
|
+
* ### Rendering
|
|
16241
|
+
*
|
|
16242
|
+
* The renderer function provides `root`, `owner`, `model` arguments when applicable.
|
|
16243
|
+
* Generate DOM content by using `model` object properties if needed, append it to the `root`
|
|
16244
|
+
* element and control the state of the host element by accessing `owner`. Before generating new
|
|
16245
|
+
* content, users are able to check if there is already content in `root` for reusing it.
|
|
16246
|
+
*
|
|
16247
|
+
* ```html
|
|
16248
|
+
* <vaadin-overlay id="overlay"></vaadin-overlay>
|
|
16249
|
+
* ```
|
|
16250
|
+
* ```js
|
|
16251
|
+
* const overlay = document.querySelector('#overlay');
|
|
16252
|
+
* overlay.renderer = function(root) {
|
|
16253
|
+
* root.textContent = "Overlay content";
|
|
16254
|
+
* };
|
|
16255
|
+
* ```
|
|
16256
|
+
*
|
|
16257
|
+
* Renderer is called on the opening of the overlay and each time the related model is updated.
|
|
16258
|
+
* DOM generated during the renderer call can be reused
|
|
16259
|
+
* in the next renderer call and will be provided with the `root` argument.
|
|
16260
|
+
* On first call it will be empty.
|
|
16261
|
+
*
|
|
16262
|
+
* ### Styling
|
|
16263
|
+
*
|
|
16264
|
+
* The following Shadow DOM parts are available for styling:
|
|
16265
|
+
*
|
|
16266
|
+
* Part name | Description
|
|
16267
|
+
* -----------|---------------------------------------------------------|
|
|
16268
|
+
* `backdrop` | Backdrop of the overlay
|
|
16269
|
+
* `overlay` | Container for position/sizing/alignment of the content
|
|
16270
|
+
* `content` | Content of the overlay
|
|
16271
|
+
*
|
|
16272
|
+
* The following state attributes are available for styling:
|
|
16273
|
+
*
|
|
16274
|
+
* Attribute | Description
|
|
16275
|
+
* ----------|------------
|
|
16276
|
+
* `opening` | Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
16277
|
+
* `closing` | Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
16278
|
+
*
|
|
16279
|
+
* The following custom CSS properties are available for styling:
|
|
16280
|
+
*
|
|
16281
|
+
* Custom CSS property | Description | Default value
|
|
16282
|
+
* ---|---|---
|
|
16283
|
+
* `--vaadin-overlay-viewport-bottom` | Bottom offset of the visible viewport area | `0` or detected offset
|
|
16284
|
+
*
|
|
16285
|
+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
|
|
16286
|
+
*
|
|
16287
|
+
* ## Attributes & Properties
|
|
16288
|
+
*
|
|
16289
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
16290
|
+
*
|
|
16291
|
+
* - `opening`/`undefined`: Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
16292
|
+
* - `closing`/`undefined`: Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
16293
|
+
* - `opened`: When true, the overlay is visible and attached to body.
|
|
16294
|
+
* - `owner`: Owner element passed with renderer function
|
|
16295
|
+
* - `model`: Object with properties that is passed to `renderer` function
|
|
16296
|
+
* - `renderer`: Custom function for rendering the content of the overlay.
|
|
16297
|
+
* Receives three arguments:
|
|
16298
|
+
*
|
|
16299
|
+
* - `root` The root container DOM element. Append your content to it.
|
|
16300
|
+
* - `owner` The host element of the renderer function.
|
|
16301
|
+
* - `model` The object with the properties related with rendering.
|
|
16302
|
+
* - `modeless`: When true the overlay won't disable the main content, showing
|
|
16303
|
+
* it doesn't change the functionality of the user interface.
|
|
16304
|
+
* - `hidden`: When set to true, the overlay is hidden. This also closes the overlay
|
|
16305
|
+
* immediately in case there is a closing animation in progress.
|
|
16306
|
+
* - `withBackdrop`: When true the overlay has backdrop on top of content when opened.
|
|
16307
|
+
* - `focusTrap`: When true, opening the overlay moves focus to the first focusable child,
|
|
16308
|
+
* or to the overlay part with tabindex if there are no focusable children.
|
|
16309
|
+
* - `restoreFocusOnClose`: Set to true to enable restoring of focus when overlay is closed.
|
|
16310
|
+
* - `restoreFocusNode`: Set to specify the element which should be focused on overlay close,
|
|
16311
|
+
* if `restoreFocusOnClose` is set to true.
|
|
16312
|
+
* - `dir`: undefined
|
|
16313
|
+
* - `_boundMouseDownListener`: undefined (property only)
|
|
16314
|
+
* - `_boundMouseUpListener`: undefined (property only)
|
|
16315
|
+
* - `_boundOutsideClickListener`: undefined (property only)
|
|
16316
|
+
* - `_boundKeydownListener`: undefined (property only)
|
|
16317
|
+
* - `__focusTrapController`: undefined (property only)
|
|
16318
|
+
* - `__focusRestorationController`: undefined (property only)
|
|
16319
|
+
*
|
|
16320
|
+
* ## Events
|
|
16321
|
+
*
|
|
16322
|
+
* Events that will be emitted by the component.
|
|
16323
|
+
*
|
|
16324
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
16325
|
+
* - `vaadin-overlay-open`: Fired after the overlay is opened.
|
|
16326
|
+
* - `vaadin-overlay-close`: Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing.
|
|
16327
|
+
* - `vaadin-overlay-closing`: Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation.
|
|
16328
|
+
* - `vaadin-overlay-closed`: Fired after the overlay is closed.
|
|
16329
|
+
* - `vaadin-overlay-outside-click`: Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.
|
|
16330
|
+
* - `vaadin-overlay-escape-press`: Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.
|
|
16331
|
+
* - `undefined`: undefined
|
|
16332
|
+
*
|
|
16333
|
+
* ## Methods
|
|
16334
|
+
*
|
|
16335
|
+
* Methods that can be called to access component functionality.
|
|
16336
|
+
*
|
|
16337
|
+
* - `requestContentUpdate() => void`: Requests an update for the content of the overlay.
|
|
16338
|
+
* While performing the update, it invokes the renderer passed in the `renderer` property.
|
|
16339
|
+
*
|
|
16340
|
+
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
16341
|
+
* - `close(sourceEvent: Event=) => void`: undefined
|
|
16342
|
+
* - `setBounds(bounds: !OverlayBoundsParam, absolute: boolean = true) => void`: Updates the coordinates of the overlay.
|
|
16343
|
+
* - `bringToFront() => void`: Brings the overlay as visually the frontmost one.
|
|
16344
|
+
* - `createProperty(name, options) => void`: undefined
|
|
16345
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
16346
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
16347
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
16348
|
+
*
|
|
16349
|
+
* ## CSS Custom Properties
|
|
16350
|
+
*
|
|
16351
|
+
* CSS variables available for styling the component.
|
|
16352
|
+
*
|
|
16353
|
+
* - `--vaadin-overlay-viewport-bottom`: Bottom offset of the visible viewport area (default: `undefined`)
|
|
16354
|
+
* - `0`: undefined (default: `undefined`)
|
|
16355
|
+
*/
|
|
16356
|
+
"vaadin-overlay": Partial<OverlayProps & BaseProps<Overlay> & BaseEvents>;
|
|
16357
16357
|
|
|
16358
16358
|
/**
|
|
16359
16359
|
* `<vaadin-radio-button>` is a web component representing a choice in a radio group.
|
|
@@ -23534,130 +23534,6 @@ export type CustomElementsSolidJs = {
|
|
|
23534
23534
|
BaseEvents
|
|
23535
23535
|
>;
|
|
23536
23536
|
|
|
23537
|
-
/**
|
|
23538
|
-
* `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
|
|
23539
|
-
* can be populated imperatively by using `renderer` callback function.
|
|
23540
|
-
*
|
|
23541
|
-
* ### Rendering
|
|
23542
|
-
*
|
|
23543
|
-
* The renderer function provides `root`, `owner`, `model` arguments when applicable.
|
|
23544
|
-
* Generate DOM content by using `model` object properties if needed, append it to the `root`
|
|
23545
|
-
* element and control the state of the host element by accessing `owner`. Before generating new
|
|
23546
|
-
* content, users are able to check if there is already content in `root` for reusing it.
|
|
23547
|
-
*
|
|
23548
|
-
* ```html
|
|
23549
|
-
* <vaadin-overlay id="overlay"></vaadin-overlay>
|
|
23550
|
-
* ```
|
|
23551
|
-
* ```js
|
|
23552
|
-
* const overlay = document.querySelector('#overlay');
|
|
23553
|
-
* overlay.renderer = function(root) {
|
|
23554
|
-
* root.textContent = "Overlay content";
|
|
23555
|
-
* };
|
|
23556
|
-
* ```
|
|
23557
|
-
*
|
|
23558
|
-
* Renderer is called on the opening of the overlay and each time the related model is updated.
|
|
23559
|
-
* DOM generated during the renderer call can be reused
|
|
23560
|
-
* in the next renderer call and will be provided with the `root` argument.
|
|
23561
|
-
* On first call it will be empty.
|
|
23562
|
-
*
|
|
23563
|
-
* ### Styling
|
|
23564
|
-
*
|
|
23565
|
-
* The following Shadow DOM parts are available for styling:
|
|
23566
|
-
*
|
|
23567
|
-
* Part name | Description
|
|
23568
|
-
* -----------|---------------------------------------------------------|
|
|
23569
|
-
* `backdrop` | Backdrop of the overlay
|
|
23570
|
-
* `overlay` | Container for position/sizing/alignment of the content
|
|
23571
|
-
* `content` | Content of the overlay
|
|
23572
|
-
*
|
|
23573
|
-
* The following state attributes are available for styling:
|
|
23574
|
-
*
|
|
23575
|
-
* Attribute | Description
|
|
23576
|
-
* ----------|------------
|
|
23577
|
-
* `opening` | Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
23578
|
-
* `closing` | Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
23579
|
-
*
|
|
23580
|
-
* The following custom CSS properties are available for styling:
|
|
23581
|
-
*
|
|
23582
|
-
* Custom CSS property | Description | Default value
|
|
23583
|
-
* ---|---|---
|
|
23584
|
-
* `--vaadin-overlay-viewport-bottom` | Bottom offset of the visible viewport area | `0` or detected offset
|
|
23585
|
-
*
|
|
23586
|
-
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
|
|
23587
|
-
*
|
|
23588
|
-
* ## Attributes & Properties
|
|
23589
|
-
*
|
|
23590
|
-
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
23591
|
-
*
|
|
23592
|
-
* - `opening`/`undefined`: Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
23593
|
-
* - `closing`/`undefined`: Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
23594
|
-
* - `opened`: When true, the overlay is visible and attached to body.
|
|
23595
|
-
* - `owner`: Owner element passed with renderer function
|
|
23596
|
-
* - `model`: Object with properties that is passed to `renderer` function
|
|
23597
|
-
* - `renderer`: Custom function for rendering the content of the overlay.
|
|
23598
|
-
* Receives three arguments:
|
|
23599
|
-
*
|
|
23600
|
-
* - `root` The root container DOM element. Append your content to it.
|
|
23601
|
-
* - `owner` The host element of the renderer function.
|
|
23602
|
-
* - `model` The object with the properties related with rendering.
|
|
23603
|
-
* - `modeless`: When true the overlay won't disable the main content, showing
|
|
23604
|
-
* it doesn't change the functionality of the user interface.
|
|
23605
|
-
* - `hidden`: When set to true, the overlay is hidden. This also closes the overlay
|
|
23606
|
-
* immediately in case there is a closing animation in progress.
|
|
23607
|
-
* - `withBackdrop`: When true the overlay has backdrop on top of content when opened.
|
|
23608
|
-
* - `focusTrap`: When true, opening the overlay moves focus to the first focusable child,
|
|
23609
|
-
* or to the overlay part with tabindex if there are no focusable children.
|
|
23610
|
-
* - `restoreFocusOnClose`: Set to true to enable restoring of focus when overlay is closed.
|
|
23611
|
-
* - `restoreFocusNode`: Set to specify the element which should be focused on overlay close,
|
|
23612
|
-
* if `restoreFocusOnClose` is set to true.
|
|
23613
|
-
* - `dir`: undefined
|
|
23614
|
-
* - `_boundMouseDownListener`: undefined (property only)
|
|
23615
|
-
* - `_boundMouseUpListener`: undefined (property only)
|
|
23616
|
-
* - `_boundOutsideClickListener`: undefined (property only)
|
|
23617
|
-
* - `_boundKeydownListener`: undefined (property only)
|
|
23618
|
-
* - `__focusTrapController`: undefined (property only)
|
|
23619
|
-
* - `__focusRestorationController`: undefined (property only)
|
|
23620
|
-
*
|
|
23621
|
-
* ## Events
|
|
23622
|
-
*
|
|
23623
|
-
* Events that will be emitted by the component.
|
|
23624
|
-
*
|
|
23625
|
-
* - `opened-changed`: Fired when the `opened` property changes.
|
|
23626
|
-
* - `vaadin-overlay-open`: Fired after the overlay is opened.
|
|
23627
|
-
* - `vaadin-overlay-close`: Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing.
|
|
23628
|
-
* - `vaadin-overlay-closing`: Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation.
|
|
23629
|
-
* - `vaadin-overlay-closed`: Fired after the overlay is closed.
|
|
23630
|
-
* - `vaadin-overlay-outside-click`: Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.
|
|
23631
|
-
* - `vaadin-overlay-escape-press`: Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.
|
|
23632
|
-
* - `undefined`: undefined
|
|
23633
|
-
*
|
|
23634
|
-
* ## Methods
|
|
23635
|
-
*
|
|
23636
|
-
* Methods that can be called to access component functionality.
|
|
23637
|
-
*
|
|
23638
|
-
* - `requestContentUpdate() => void`: Requests an update for the content of the overlay.
|
|
23639
|
-
* While performing the update, it invokes the renderer passed in the `renderer` property.
|
|
23640
|
-
*
|
|
23641
|
-
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
23642
|
-
* - `close(sourceEvent: Event=) => void`: undefined
|
|
23643
|
-
* - `setBounds(bounds: !OverlayBoundsParam, absolute: boolean = true) => void`: Updates the coordinates of the overlay.
|
|
23644
|
-
* - `bringToFront() => void`: Brings the overlay as visually the frontmost one.
|
|
23645
|
-
* - `createProperty(name, options) => void`: undefined
|
|
23646
|
-
* - `getOrCreateMap(name) => void`: undefined
|
|
23647
|
-
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
23648
|
-
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
23649
|
-
*
|
|
23650
|
-
* ## CSS Custom Properties
|
|
23651
|
-
*
|
|
23652
|
-
* CSS variables available for styling the component.
|
|
23653
|
-
*
|
|
23654
|
-
* - `--vaadin-overlay-viewport-bottom`: Bottom offset of the visible viewport area (default: `undefined`)
|
|
23655
|
-
* - `0`: undefined (default: `undefined`)
|
|
23656
|
-
*/
|
|
23657
|
-
"vaadin-overlay": Partial<
|
|
23658
|
-
OverlayProps & OverlaySolidJsProps & BaseProps<Overlay> & BaseEvents
|
|
23659
|
-
>;
|
|
23660
|
-
|
|
23661
23537
|
/**
|
|
23662
23538
|
* `<vaadin-password-field>` is an extension of `<vaadin-text-field>` component for entering passwords.
|
|
23663
23539
|
*
|
|
@@ -23801,6 +23677,130 @@ export type CustomElementsSolidJs = {
|
|
|
23801
23677
|
BaseEvents
|
|
23802
23678
|
>;
|
|
23803
23679
|
|
|
23680
|
+
/**
|
|
23681
|
+
* `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
|
|
23682
|
+
* can be populated imperatively by using `renderer` callback function.
|
|
23683
|
+
*
|
|
23684
|
+
* ### Rendering
|
|
23685
|
+
*
|
|
23686
|
+
* The renderer function provides `root`, `owner`, `model` arguments when applicable.
|
|
23687
|
+
* Generate DOM content by using `model` object properties if needed, append it to the `root`
|
|
23688
|
+
* element and control the state of the host element by accessing `owner`. Before generating new
|
|
23689
|
+
* content, users are able to check if there is already content in `root` for reusing it.
|
|
23690
|
+
*
|
|
23691
|
+
* ```html
|
|
23692
|
+
* <vaadin-overlay id="overlay"></vaadin-overlay>
|
|
23693
|
+
* ```
|
|
23694
|
+
* ```js
|
|
23695
|
+
* const overlay = document.querySelector('#overlay');
|
|
23696
|
+
* overlay.renderer = function(root) {
|
|
23697
|
+
* root.textContent = "Overlay content";
|
|
23698
|
+
* };
|
|
23699
|
+
* ```
|
|
23700
|
+
*
|
|
23701
|
+
* Renderer is called on the opening of the overlay and each time the related model is updated.
|
|
23702
|
+
* DOM generated during the renderer call can be reused
|
|
23703
|
+
* in the next renderer call and will be provided with the `root` argument.
|
|
23704
|
+
* On first call it will be empty.
|
|
23705
|
+
*
|
|
23706
|
+
* ### Styling
|
|
23707
|
+
*
|
|
23708
|
+
* The following Shadow DOM parts are available for styling:
|
|
23709
|
+
*
|
|
23710
|
+
* Part name | Description
|
|
23711
|
+
* -----------|---------------------------------------------------------|
|
|
23712
|
+
* `backdrop` | Backdrop of the overlay
|
|
23713
|
+
* `overlay` | Container for position/sizing/alignment of the content
|
|
23714
|
+
* `content` | Content of the overlay
|
|
23715
|
+
*
|
|
23716
|
+
* The following state attributes are available for styling:
|
|
23717
|
+
*
|
|
23718
|
+
* Attribute | Description
|
|
23719
|
+
* ----------|------------
|
|
23720
|
+
* `opening` | Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
23721
|
+
* `closing` | Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
23722
|
+
*
|
|
23723
|
+
* The following custom CSS properties are available for styling:
|
|
23724
|
+
*
|
|
23725
|
+
* Custom CSS property | Description | Default value
|
|
23726
|
+
* ---|---|---
|
|
23727
|
+
* `--vaadin-overlay-viewport-bottom` | Bottom offset of the visible viewport area | `0` or detected offset
|
|
23728
|
+
*
|
|
23729
|
+
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
|
|
23730
|
+
*
|
|
23731
|
+
* ## Attributes & Properties
|
|
23732
|
+
*
|
|
23733
|
+
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
23734
|
+
*
|
|
23735
|
+
* - `opening`/`undefined`: Applied just after the overlay is opened. You can apply a CSS animation for this state.
|
|
23736
|
+
* - `closing`/`undefined`: Applied just before the overlay is closed. You can apply a CSS animation for this state.
|
|
23737
|
+
* - `opened`: When true, the overlay is visible and attached to body.
|
|
23738
|
+
* - `owner`: Owner element passed with renderer function
|
|
23739
|
+
* - `model`: Object with properties that is passed to `renderer` function
|
|
23740
|
+
* - `renderer`: Custom function for rendering the content of the overlay.
|
|
23741
|
+
* Receives three arguments:
|
|
23742
|
+
*
|
|
23743
|
+
* - `root` The root container DOM element. Append your content to it.
|
|
23744
|
+
* - `owner` The host element of the renderer function.
|
|
23745
|
+
* - `model` The object with the properties related with rendering.
|
|
23746
|
+
* - `modeless`: When true the overlay won't disable the main content, showing
|
|
23747
|
+
* it doesn't change the functionality of the user interface.
|
|
23748
|
+
* - `hidden`: When set to true, the overlay is hidden. This also closes the overlay
|
|
23749
|
+
* immediately in case there is a closing animation in progress.
|
|
23750
|
+
* - `withBackdrop`: When true the overlay has backdrop on top of content when opened.
|
|
23751
|
+
* - `focusTrap`: When true, opening the overlay moves focus to the first focusable child,
|
|
23752
|
+
* or to the overlay part with tabindex if there are no focusable children.
|
|
23753
|
+
* - `restoreFocusOnClose`: Set to true to enable restoring of focus when overlay is closed.
|
|
23754
|
+
* - `restoreFocusNode`: Set to specify the element which should be focused on overlay close,
|
|
23755
|
+
* if `restoreFocusOnClose` is set to true.
|
|
23756
|
+
* - `dir`: undefined
|
|
23757
|
+
* - `_boundMouseDownListener`: undefined (property only)
|
|
23758
|
+
* - `_boundMouseUpListener`: undefined (property only)
|
|
23759
|
+
* - `_boundOutsideClickListener`: undefined (property only)
|
|
23760
|
+
* - `_boundKeydownListener`: undefined (property only)
|
|
23761
|
+
* - `__focusTrapController`: undefined (property only)
|
|
23762
|
+
* - `__focusRestorationController`: undefined (property only)
|
|
23763
|
+
*
|
|
23764
|
+
* ## Events
|
|
23765
|
+
*
|
|
23766
|
+
* Events that will be emitted by the component.
|
|
23767
|
+
*
|
|
23768
|
+
* - `opened-changed`: Fired when the `opened` property changes.
|
|
23769
|
+
* - `vaadin-overlay-open`: Fired after the overlay is opened.
|
|
23770
|
+
* - `vaadin-overlay-close`: Fired when the opened overlay is about to be closed. Calling `preventDefault()` on the event cancels the closing.
|
|
23771
|
+
* - `vaadin-overlay-closing`: Fired when the overlay starts to close. Closing the overlay can be asynchronous depending on the animation.
|
|
23772
|
+
* - `vaadin-overlay-closed`: Fired after the overlay is closed.
|
|
23773
|
+
* - `vaadin-overlay-outside-click`: Fired before the overlay is closed on outside click. Calling `preventDefault()` on the event cancels the closing.
|
|
23774
|
+
* - `vaadin-overlay-escape-press`: Fired before the overlay is closed on Escape key press. Calling `preventDefault()` on the event cancels the closing.
|
|
23775
|
+
* - `undefined`: undefined
|
|
23776
|
+
*
|
|
23777
|
+
* ## Methods
|
|
23778
|
+
*
|
|
23779
|
+
* Methods that can be called to access component functionality.
|
|
23780
|
+
*
|
|
23781
|
+
* - `requestContentUpdate() => void`: Requests an update for the content of the overlay.
|
|
23782
|
+
* While performing the update, it invokes the renderer passed in the `renderer` property.
|
|
23783
|
+
*
|
|
23784
|
+
* It is not guaranteed that the update happens immediately (synchronously) after it is requested.
|
|
23785
|
+
* - `close(sourceEvent: Event=) => void`: undefined
|
|
23786
|
+
* - `setBounds(bounds: !OverlayBoundsParam, absolute: boolean = true) => void`: Updates the coordinates of the overlay.
|
|
23787
|
+
* - `bringToFront() => void`: Brings the overlay as visually the frontmost one.
|
|
23788
|
+
* - `createProperty(name, options) => void`: undefined
|
|
23789
|
+
* - `getOrCreateMap(name) => void`: undefined
|
|
23790
|
+
* - `addCheckedInitializer(initializer) => void`: undefined
|
|
23791
|
+
* - `getPropertyDescriptor(name, key, options) => void`: undefined
|
|
23792
|
+
*
|
|
23793
|
+
* ## CSS Custom Properties
|
|
23794
|
+
*
|
|
23795
|
+
* CSS variables available for styling the component.
|
|
23796
|
+
*
|
|
23797
|
+
* - `--vaadin-overlay-viewport-bottom`: Bottom offset of the visible viewport area (default: `undefined`)
|
|
23798
|
+
* - `0`: undefined (default: `undefined`)
|
|
23799
|
+
*/
|
|
23800
|
+
"vaadin-overlay": Partial<
|
|
23801
|
+
OverlayProps & OverlaySolidJsProps & BaseProps<Overlay> & BaseEvents
|
|
23802
|
+
>;
|
|
23803
|
+
|
|
23804
23804
|
/**
|
|
23805
23805
|
* `<vaadin-radio-button>` is a web component representing a choice in a radio group.
|
|
23806
23806
|
* Only one radio button in the group can be selected at the same time.
|