@limetech/lime-elements 37.49.0 → 37.49.1

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.
@@ -3,22 +3,37 @@ import { OpenDirection } from '../menu/menu.types';
3
3
  * The portal component provides a way to render children into a DOM node that
4
4
  * exist outside the DOM hierarchy of the parent component.
5
5
  *
6
+ * When the limel-portal component is used, it creates a new DOM node (a div element)
7
+ * and appends it to a parent element (by default, the body of the document).
8
+ * The child elements of the limel-portal are then moved from
9
+ * their original location in the DOM to this new div element.
10
+ *
11
+ * This technique is often used to overcome CSS stacking context issues,
12
+ * or to render UI elements like modals, dropdowns, tooltips, etc.,
13
+ * that need to visually "break out" of their container.
14
+ *
15
+ * Using this component, we ensure that the content is always rendered in the
16
+ * correct position, and never covers its own trigger, or another component
17
+ * that is opened in the stacking layer. This way, we don't need to worry about
18
+ * z-indexes, or other stacking context issues.
19
+ *
20
+ * :::important
6
21
  * There are some caveats when using this component
7
22
  *
8
- * Events might not bubble up as expected since the content is moved out to
23
+ * 1. Events might not bubble up as expected since the content is moved out to
9
24
  * another DOM node.
10
- * Any styling that is applied to content from the parent will be lost, if the
11
- * content is just another web compoent it will work without any issues.
12
- * Alternatively, use the
13
- * `style=""` html attribute.
14
- * Any component that is placed inside the container must have a style of
25
+ * 2. Any styling that is applied to content from the parent will be lost, if the
26
+ * content is just another web-component it will work without any issues.
27
+ * Alternatively, use the `style=""` html attribute.
28
+ * 3. Any component that is placed inside the container must have a style of
15
29
  * `max-height: inherit`. This ensures that its placement is calculated
16
30
  * correctly in relation to the trigger, and that it never covers its own
17
31
  * trigger.
18
- * When the node is moved in the DOM, `disconnectedCallback` and
32
+ * 4. When the node is moved in the DOM, `disconnectedCallback` and
19
33
  * `connectedCallback` will be invoked, so if `disconnectedCallback` is used
20
34
  * to do any tear-down, the appropriate setup will have to be done again on
21
35
  * `connectedCallback`.
36
+ * :::
22
37
  *
23
38
  * @slot - Content to put inside the portal
24
39
  * @private
@@ -42,7 +57,14 @@ export declare class Portal {
42
57
  */
43
58
  containerStyle: object;
44
59
  /**
45
- * Parent element to move the content to.
60
+ * The `parent` property specifies the parent element where the content
61
+ * of the portal will be moved to.
62
+ * By default, it is set to `document.body`, meaning the content
63
+ * will be appended as a child of the body element in the DOM.
64
+ * If you want the content to be appended to a different element,
65
+ * you can specify that element by setting this property.
66
+ * Please note that the specified parent element should exist
67
+ * in the DOM at the time of rendering the portal.
46
68
  */
47
69
  parent: HTMLElement;
48
70
  /**
@@ -36,6 +36,7 @@ export declare class ProsemirrorAdapter {
36
36
  private schema;
37
37
  private contentConverter;
38
38
  private suppressChangeEvent;
39
+ private actionBarElement;
39
40
  /**
40
41
  * Dispatched when a change is made to the editor
41
42
  */
@@ -1981,21 +1981,33 @@ export namespace Components {
1981
1981
  /**
1982
1982
  * The portal component provides a way to render children into a DOM node that
1983
1983
  * exist outside the DOM hierarchy of the parent component.
1984
+ * When the limel-portal component is used, it creates a new DOM node (a div element)
1985
+ * and appends it to a parent element (by default, the body of the document).
1986
+ * The child elements of the limel-portal are then moved from
1987
+ * their original location in the DOM to this new div element.
1988
+ * This technique is often used to overcome CSS stacking context issues,
1989
+ * or to render UI elements like modals, dropdowns, tooltips, etc.,
1990
+ * that need to visually "break out" of their container.
1991
+ * Using this component, we ensure that the content is always rendered in the
1992
+ * correct position, and never covers its own trigger, or another component
1993
+ * that is opened in the stacking layer. This way, we don't need to worry about
1994
+ * z-indexes, or other stacking context issues.
1995
+ * :::important
1984
1996
  * There are some caveats when using this component
1985
- * Events might not bubble up as expected since the content is moved out to
1997
+ * 1. Events might not bubble up as expected since the content is moved out to
1986
1998
  * another DOM node.
1987
- * Any styling that is applied to content from the parent will be lost, if the
1988
- * content is just another web compoent it will work without any issues.
1989
- * Alternatively, use the
1990
- * `style=""` html attribute.
1991
- * Any component that is placed inside the container must have a style of
1999
+ * 2. Any styling that is applied to content from the parent will be lost, if the
2000
+ * content is just another web-component it will work without any issues.
2001
+ * Alternatively, use the `style=""` html attribute.
2002
+ * 3. Any component that is placed inside the container must have a style of
1992
2003
  * `max-height: inherit`. This ensures that its placement is calculated
1993
2004
  * correctly in relation to the trigger, and that it never covers its own
1994
2005
  * trigger.
1995
- * When the node is moved in the DOM, `disconnectedCallback` and
2006
+ * 4. When the node is moved in the DOM, `disconnectedCallback` and
1996
2007
  * `connectedCallback` will be invoked, so if `disconnectedCallback` is used
1997
2008
  * to do any tear-down, the appropriate setup will have to be done again on
1998
2009
  * `connectedCallback`.
2010
+ * :::
1999
2011
  * @private
2000
2012
  * @exampleComponent limel-example-portal-basic
2001
2013
  */
@@ -2021,7 +2033,7 @@ export namespace Components {
2021
2033
  */
2022
2034
  "openDirection": OpenDirection;
2023
2035
  /**
2024
- * Parent element to move the content to.
2036
+ * The `parent` property specifies the parent element where the content of the portal will be moved to. By default, it is set to `document.body`, meaning the content will be appended as a child of the body element in the DOM. If you want the content to be appended to a different element, you can specify that element by setting this property. Please note that the specified parent element should exist in the DOM at the time of rendering the portal.
2025
2037
  */
2026
2038
  "parent": HTMLElement;
2027
2039
  /**
@@ -3840,21 +3852,33 @@ declare global {
3840
3852
  /**
3841
3853
  * The portal component provides a way to render children into a DOM node that
3842
3854
  * exist outside the DOM hierarchy of the parent component.
3855
+ * When the limel-portal component is used, it creates a new DOM node (a div element)
3856
+ * and appends it to a parent element (by default, the body of the document).
3857
+ * The child elements of the limel-portal are then moved from
3858
+ * their original location in the DOM to this new div element.
3859
+ * This technique is often used to overcome CSS stacking context issues,
3860
+ * or to render UI elements like modals, dropdowns, tooltips, etc.,
3861
+ * that need to visually "break out" of their container.
3862
+ * Using this component, we ensure that the content is always rendered in the
3863
+ * correct position, and never covers its own trigger, or another component
3864
+ * that is opened in the stacking layer. This way, we don't need to worry about
3865
+ * z-indexes, or other stacking context issues.
3866
+ * :::important
3843
3867
  * There are some caveats when using this component
3844
- * Events might not bubble up as expected since the content is moved out to
3868
+ * 1. Events might not bubble up as expected since the content is moved out to
3845
3869
  * another DOM node.
3846
- * Any styling that is applied to content from the parent will be lost, if the
3847
- * content is just another web compoent it will work without any issues.
3848
- * Alternatively, use the
3849
- * `style=""` html attribute.
3850
- * Any component that is placed inside the container must have a style of
3870
+ * 2. Any styling that is applied to content from the parent will be lost, if the
3871
+ * content is just another web-component it will work without any issues.
3872
+ * Alternatively, use the `style=""` html attribute.
3873
+ * 3. Any component that is placed inside the container must have a style of
3851
3874
  * `max-height: inherit`. This ensures that its placement is calculated
3852
3875
  * correctly in relation to the trigger, and that it never covers its own
3853
3876
  * trigger.
3854
- * When the node is moved in the DOM, `disconnectedCallback` and
3877
+ * 4. When the node is moved in the DOM, `disconnectedCallback` and
3855
3878
  * `connectedCallback` will be invoked, so if `disconnectedCallback` is used
3856
3879
  * to do any tear-down, the appropriate setup will have to be done again on
3857
3880
  * `connectedCallback`.
3881
+ * :::
3858
3882
  * @private
3859
3883
  * @exampleComponent limel-example-portal-basic
3860
3884
  */
@@ -6333,21 +6357,33 @@ declare namespace LocalJSX {
6333
6357
  /**
6334
6358
  * The portal component provides a way to render children into a DOM node that
6335
6359
  * exist outside the DOM hierarchy of the parent component.
6360
+ * When the limel-portal component is used, it creates a new DOM node (a div element)
6361
+ * and appends it to a parent element (by default, the body of the document).
6362
+ * The child elements of the limel-portal are then moved from
6363
+ * their original location in the DOM to this new div element.
6364
+ * This technique is often used to overcome CSS stacking context issues,
6365
+ * or to render UI elements like modals, dropdowns, tooltips, etc.,
6366
+ * that need to visually "break out" of their container.
6367
+ * Using this component, we ensure that the content is always rendered in the
6368
+ * correct position, and never covers its own trigger, or another component
6369
+ * that is opened in the stacking layer. This way, we don't need to worry about
6370
+ * z-indexes, or other stacking context issues.
6371
+ * :::important
6336
6372
  * There are some caveats when using this component
6337
- * Events might not bubble up as expected since the content is moved out to
6373
+ * 1. Events might not bubble up as expected since the content is moved out to
6338
6374
  * another DOM node.
6339
- * Any styling that is applied to content from the parent will be lost, if the
6340
- * content is just another web compoent it will work without any issues.
6341
- * Alternatively, use the
6342
- * `style=""` html attribute.
6343
- * Any component that is placed inside the container must have a style of
6375
+ * 2. Any styling that is applied to content from the parent will be lost, if the
6376
+ * content is just another web-component it will work without any issues.
6377
+ * Alternatively, use the `style=""` html attribute.
6378
+ * 3. Any component that is placed inside the container must have a style of
6344
6379
  * `max-height: inherit`. This ensures that its placement is calculated
6345
6380
  * correctly in relation to the trigger, and that it never covers its own
6346
6381
  * trigger.
6347
- * When the node is moved in the DOM, `disconnectedCallback` and
6382
+ * 4. When the node is moved in the DOM, `disconnectedCallback` and
6348
6383
  * `connectedCallback` will be invoked, so if `disconnectedCallback` is used
6349
6384
  * to do any tear-down, the appropriate setup will have to be done again on
6350
6385
  * `connectedCallback`.
6386
+ * :::
6351
6387
  * @private
6352
6388
  * @exampleComponent limel-example-portal-basic
6353
6389
  */
@@ -6373,7 +6409,7 @@ declare namespace LocalJSX {
6373
6409
  */
6374
6410
  "openDirection"?: OpenDirection;
6375
6411
  /**
6376
- * Parent element to move the content to.
6412
+ * The `parent` property specifies the parent element where the content of the portal will be moved to. By default, it is set to `document.body`, meaning the content will be appended as a child of the body element in the DOM. If you want the content to be appended to a different element, you can specify that element by setting this property. Please note that the specified parent element should exist in the DOM at the time of rendering the portal.
6377
6413
  */
6378
6414
  "parent"?: HTMLElement;
6379
6415
  /**
@@ -7939,21 +7975,33 @@ declare module "@stencil/core" {
7939
7975
  /**
7940
7976
  * The portal component provides a way to render children into a DOM node that
7941
7977
  * exist outside the DOM hierarchy of the parent component.
7978
+ * When the limel-portal component is used, it creates a new DOM node (a div element)
7979
+ * and appends it to a parent element (by default, the body of the document).
7980
+ * The child elements of the limel-portal are then moved from
7981
+ * their original location in the DOM to this new div element.
7982
+ * This technique is often used to overcome CSS stacking context issues,
7983
+ * or to render UI elements like modals, dropdowns, tooltips, etc.,
7984
+ * that need to visually "break out" of their container.
7985
+ * Using this component, we ensure that the content is always rendered in the
7986
+ * correct position, and never covers its own trigger, or another component
7987
+ * that is opened in the stacking layer. This way, we don't need to worry about
7988
+ * z-indexes, or other stacking context issues.
7989
+ * :::important
7942
7990
  * There are some caveats when using this component
7943
- * Events might not bubble up as expected since the content is moved out to
7991
+ * 1. Events might not bubble up as expected since the content is moved out to
7944
7992
  * another DOM node.
7945
- * Any styling that is applied to content from the parent will be lost, if the
7946
- * content is just another web compoent it will work without any issues.
7947
- * Alternatively, use the
7948
- * `style=""` html attribute.
7949
- * Any component that is placed inside the container must have a style of
7993
+ * 2. Any styling that is applied to content from the parent will be lost, if the
7994
+ * content is just another web-component it will work without any issues.
7995
+ * Alternatively, use the `style=""` html attribute.
7996
+ * 3. Any component that is placed inside the container must have a style of
7950
7997
  * `max-height: inherit`. This ensures that its placement is calculated
7951
7998
  * correctly in relation to the trigger, and that it never covers its own
7952
7999
  * trigger.
7953
- * When the node is moved in the DOM, `disconnectedCallback` and
8000
+ * 4. When the node is moved in the DOM, `disconnectedCallback` and
7954
8001
  * `connectedCallback` will be invoked, so if `disconnectedCallback` is used
7955
8002
  * to do any tear-down, the appropriate setup will have to be done again on
7956
8003
  * `connectedCallback`.
8004
+ * :::
7957
8005
  * @private
7958
8006
  * @exampleComponent limel-example-portal-basic
7959
8007
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@limetech/lime-elements",
3
- "version": "37.49.0",
3
+ "version": "37.49.1",
4
4
  "description": "Lime Elements",
5
5
  "author": "Lime Technologies",
6
6
  "license": "Apache-2.0",