@odx/foundation 1.0.0-beta.217 → 1.0.0-beta.219

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/README.md CHANGED
@@ -23,14 +23,14 @@ To install `@odx/foundation` and it's peer dependencies in your project, run the
23
23
  npm install @odx/foundation @odx/icons@next --save
24
24
  ```
25
25
 
26
- > We depend on the <a href="https://lit.dev" target="_blank" rel="noopener">**Lit package**</a> for building web elements because it offers a lightweight, efficient framework with a simple syntax for creating fast, reusable elements. Its powerful templating system ensures high performance and seamless user experience. Lit is also highly interoperable, making it easy to integrate with other frameworks and libraries.
26
+ > We depend on the <a href="https://lit.dev" target="_blank" rel="noopener">Lit package</a> for building web elements because it offers a lightweight, efficient framework with a simple syntax for creating fast, reusable elements. Its powerful templating system ensures high performance and seamless user experience. Lit is also highly interoperable, making it easy to integrate with other frameworks and libraries.
27
27
  >
28
28
  > [<img src="https://img.shields.io/npm/dependency-version/@odx/foundation/lit" />](https://npmjs.org/package/lit)
29
29
 
30
30
 
31
31
  ### Setup
32
32
 
33
- > Ensure that you have followed the installation and setup instructions for our [**design tokens**](https://npmjs.org/package/@odx/design-tokens) library.
33
+ > Ensure that you have followed the installation and setup instructions for our [design tokens](https://npmjs.org/package/@odx/design-tokens) library.
34
34
 
35
35
  Once installed, you can import the foundational components and styles into your project:
36
36
 
@@ -90,13 +90,13 @@ export class Title {
90
90
 
91
91
  #### React Example
92
92
 
93
- See <odx-link href="https://lit.dev/docs/frameworks/react/" target="_blank" strong>Lit documentation</odx-link> for more information on how to use web components in React.
93
+ See <a href="https://lit.dev/docs/frameworks/react/" target="_blank">Lit documentation</a> for more information on how to use web components in React.
94
94
 
95
95
 
96
96
 
97
97
  ### Documentation
98
98
 
99
- For detailed documentation on how to use the `@odx/foundation` package, including examples and best practices, please visit our <a href="https://odx.draeger.com" target="_blank" rel="noopener">**documentation**</a>.
99
+ For detailed documentation on how to use the `@odx/foundation` package, including examples and best practices, please visit our <a href="https://odx.draeger.com" target="_blank" rel="noopener">documentation</a>.
100
100
 
101
101
  ### Contact
102
- For questions, feedback, or support, please reach out to us through our <a href="https://odx.draeger.com/contact" target="_blank" rel="noopener">**contact page**</a>.
102
+ For questions, feedback, or support, please reach out to us through our <a href="https://odx.draeger.com/contact" target="_blank" rel="noopener">contact page</a>.
@@ -26,10 +26,13 @@ export declare const AvatarVariant: Pick<{
26
26
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
27
27
  readonly PRIMARY: "primary";
28
28
  readonly ACCENT: "accent";
29
+ readonly ACCENT_GHOST: "accent-ghost";
29
30
  readonly SUCCESS: "success";
30
31
  readonly WARNING: "warning";
31
32
  readonly DANGER: "danger";
32
- }, "NEUTRAL" | "PRIMARY" | "ACCENT">;
33
+ readonly DANGER_GHOST: "danger-ghost";
34
+ readonly GHOST: "ghost";
35
+ }, "NEUTRAL" | "PRIMARY" | "ACCENT" | "GHOST">;
33
36
  export declare class OdxAvatar extends CustomElement {
34
37
  interactive: boolean;
35
38
  name: string;
@@ -6,11 +6,6 @@ declare global {
6
6
  'odx-badge': OdxBadge;
7
7
  }
8
8
  }
9
- export type BadgeAppearance = ValuesOf<typeof BadgeAppearance>;
10
- export declare const BadgeAppearance: Pick<{
11
- readonly FILL: "fill";
12
- readonly GHOST: "ghost";
13
- }, "FILL" | "GHOST">;
14
9
  export type BadgeSize = ValuesOf<typeof BadgeSize>;
15
10
  export declare const BadgeSize: Pick<{
16
11
  readonly XS: "xs";
@@ -26,12 +21,14 @@ export declare const BadgeVariant: Pick<{
26
21
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
27
22
  readonly PRIMARY: "primary";
28
23
  readonly ACCENT: "accent";
24
+ readonly ACCENT_GHOST: "accent-ghost";
29
25
  readonly SUCCESS: "success";
30
26
  readonly WARNING: "warning";
31
27
  readonly DANGER: "danger";
32
- }, "NEUTRAL" | "PRIMARY" | "ACCENT" | "SUCCESS" | "WARNING" | "DANGER">;
28
+ readonly DANGER_GHOST: "danger-ghost";
29
+ readonly GHOST: "ghost";
30
+ }, "NEUTRAL" | "PRIMARY" | "ACCENT" | "ACCENT_GHOST" | "SUCCESS" | "WARNING" | "DANGER" | "DANGER_GHOST" | "GHOST">;
33
31
  export declare class OdxBadge extends CustomElement {
34
- appearance: BadgeAppearance;
35
32
  animated: boolean;
36
33
  compact: boolean;
37
34
  size: BadgeSize;
@@ -10,15 +10,23 @@ declare global {
10
10
  'odx-breadcrumbs': OdxBreadcrumbs;
11
11
  }
12
12
  }
13
- export type BreadcrumbsAppearance = ValuesOf<typeof BreadcrumbsAppearance>;
14
- export declare const BreadcrumbsAppearance: Pick<{
15
- readonly FILL: "fill";
13
+ export type BreadcrumbsVariant = ValuesOf<typeof BreadcrumbsVariant>;
14
+ export declare const BreadcrumbsVariant: Pick<{
15
+ readonly NEUTRAL: "neutral";
16
+ readonly NEUTRAL_SUBTLE: "neutral-subtle";
17
+ readonly PRIMARY: "primary";
18
+ readonly ACCENT: "accent";
19
+ readonly ACCENT_GHOST: "accent-ghost";
20
+ readonly SUCCESS: "success";
21
+ readonly WARNING: "warning";
22
+ readonly DANGER: "danger";
23
+ readonly DANGER_GHOST: "danger-ghost";
16
24
  readonly GHOST: "ghost";
17
- }, "FILL" | "GHOST">;
25
+ }, "PRIMARY" | "GHOST">;
18
26
  export declare class OdxBreadcrumbs extends CustomElement {
19
27
  #private;
20
- appearance: BreadcrumbsAppearance;
21
28
  max: number;
29
+ variant: BreadcrumbsVariant;
22
30
  connectedCallback(): void;
23
31
  protected render(): TemplateResult;
24
32
  protected updated(props: PropertyValues<this>): void;
@@ -7,11 +7,6 @@ declare global {
7
7
  }
8
8
  }
9
9
  export declare const buttonDirective: import('../../utils/main.js').BooleanAttributeDirective<"odx-button">;
10
- export type ButtonAppearance = ValuesOf<typeof ButtonAppearance>;
11
- export declare const ButtonAppearance: Pick<{
12
- readonly FILL: "fill";
13
- readonly GHOST: "ghost";
14
- }, "FILL" | "GHOST">;
15
10
  export type ButtonBadgePosition = ValuesOf<typeof ButtonBadgePosition>;
16
11
  export declare const ButtonBadgePosition: Pick<{
17
12
  readonly START: "start";
@@ -24,15 +19,17 @@ export declare const ButtonVariant: Pick<{
24
19
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
25
20
  readonly PRIMARY: "primary";
26
21
  readonly ACCENT: "accent";
22
+ readonly ACCENT_GHOST: "accent-ghost";
27
23
  readonly SUCCESS: "success";
28
24
  readonly WARNING: "warning";
29
25
  readonly DANGER: "danger";
30
- }, "NEUTRAL" | "PRIMARY" | "ACCENT" | "WARNING" | "DANGER">;
26
+ readonly DANGER_GHOST: "danger-ghost";
27
+ readonly GHOST: "ghost";
28
+ }, "NEUTRAL" | "PRIMARY" | "ACCENT" | "WARNING" | "DANGER" | "DANGER_GHOST" | "GHOST">;
31
29
  export declare class OdxButton extends LinkControlElement {
32
30
  #private;
33
31
  static readonly formAssociated = true;
34
32
  active: boolean;
35
- appearance: ButtonAppearance;
36
33
  badgePosition: ButtonBadgePosition;
37
34
  /**
38
35
  * The type of the button.
@@ -1,13 +1,12 @@
1
1
  import { ControlSize, CustomElement } from '../../main.js';
2
2
  import { PropertyValues, TemplateResult } from 'lit';
3
- import { ButtonAppearance, ButtonVariant } from '../button/button.js';
3
+ import { ButtonVariant } from '../button/button.js';
4
4
  declare global {
5
5
  interface HTMLElementTagNameMap {
6
6
  'odx-button-group': OdxButtonGroup;
7
7
  }
8
8
  }
9
9
  export declare class OdxButtonGroup extends CustomElement {
10
- appearance?: ButtonAppearance;
11
10
  size: ControlSize;
12
11
  variant?: ButtonVariant;
13
12
  vertical: boolean;
@@ -6,16 +6,24 @@ declare global {
6
6
  'odx-card': OdxCard;
7
7
  }
8
8
  }
9
- export type CardAppearance = ValuesOf<typeof CardAppearance>;
10
- export declare const CardAppearance: Pick<{
11
- readonly FILL: "fill";
9
+ export type CardVariant = ValuesOf<typeof CardVariant>;
10
+ export declare const CardVariant: Pick<{
11
+ readonly NEUTRAL: "neutral";
12
+ readonly NEUTRAL_SUBTLE: "neutral-subtle";
13
+ readonly PRIMARY: "primary";
14
+ readonly ACCENT: "accent";
15
+ readonly ACCENT_GHOST: "accent-ghost";
16
+ readonly SUCCESS: "success";
17
+ readonly WARNING: "warning";
18
+ readonly DANGER: "danger";
19
+ readonly DANGER_GHOST: "danger-ghost";
12
20
  readonly GHOST: "ghost";
13
- }, "FILL" | "GHOST">;
21
+ }, "NEUTRAL" | "GHOST">;
14
22
  declare const OdxCard_base: import('../../utils/main.js').Constructor<CanBeDisabled> & typeof CustomElement;
15
23
  export declare class OdxCard extends OdxCard_base {
16
24
  #private;
17
- appearance: CardAppearance;
18
25
  interactive: boolean;
26
+ variant: CardVariant;
19
27
  protected updated(props: PropertyValues<this>): void;
20
28
  protected render(): TemplateResult;
21
29
  }
@@ -12,9 +12,12 @@ export declare const ChipVariant: Pick<{
12
12
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
13
13
  readonly PRIMARY: "primary";
14
14
  readonly ACCENT: "accent";
15
+ readonly ACCENT_GHOST: "accent-ghost";
15
16
  readonly SUCCESS: "success";
16
17
  readonly WARNING: "warning";
17
18
  readonly DANGER: "danger";
19
+ readonly DANGER_GHOST: "danger-ghost";
20
+ readonly GHOST: "ghost";
18
21
  }, "NEUTRAL" | "NEUTRAL_SUBTLE" | "PRIMARY" | "ACCENT" | "SUCCESS" | "WARNING" | "DANGER">;
19
22
  declare const OdxChip_base: import('../../utils/main.js').Constructor<CanBeDisabled> & typeof CustomElement;
20
23
  export declare class OdxChip extends OdxChip_base {
@@ -28,9 +28,12 @@ export declare const EmptyStateVariant: Pick<{
28
28
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
29
29
  readonly PRIMARY: "primary";
30
30
  readonly ACCENT: "accent";
31
+ readonly ACCENT_GHOST: "accent-ghost";
31
32
  readonly SUCCESS: "success";
32
33
  readonly WARNING: "warning";
33
34
  readonly DANGER: "danger";
35
+ readonly DANGER_GHOST: "danger-ghost";
36
+ readonly GHOST: "ghost";
34
37
  }, "NEUTRAL" | "NEUTRAL_SUBTLE" | "DANGER">;
35
38
  export declare class OdxEmptyState extends CustomElement {
36
39
  alignment: EmptyStateAlignment;
@@ -16,9 +16,12 @@ export declare const HighlightVariant: Pick<{
16
16
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
17
17
  readonly PRIMARY: "primary";
18
18
  readonly ACCENT: "accent";
19
+ readonly ACCENT_GHOST: "accent-ghost";
19
20
  readonly SUCCESS: "success";
20
21
  readonly WARNING: "warning";
21
22
  readonly DANGER: "danger";
23
+ readonly DANGER_GHOST: "danger-ghost";
24
+ readonly GHOST: "ghost";
22
25
  }, "NEUTRAL" | "ACCENT" | "DANGER">;
23
26
  declare const OdxHighlight_base: import('../../utils/main.js').Constructor<CanBeDisabled> & typeof CustomElement;
24
27
  export declare class OdxHighlight extends OdxHighlight_base {
@@ -13,9 +13,12 @@ export declare const InlineMessageVariant: Pick<{
13
13
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
14
14
  readonly PRIMARY: "primary";
15
15
  readonly ACCENT: "accent";
16
+ readonly ACCENT_GHOST: "accent-ghost";
16
17
  readonly SUCCESS: "success";
17
18
  readonly WARNING: "warning";
18
19
  readonly DANGER: "danger";
20
+ readonly DANGER_GHOST: "danger-ghost";
21
+ readonly GHOST: "ghost";
19
22
  }, "NEUTRAL" | "PRIMARY" | "SUCCESS" | "WARNING" | "DANGER">;
20
23
  export declare class OdxInlineMessage extends CustomElement {
21
24
  dismissible: boolean;
@@ -32,9 +32,12 @@ export declare const KeyValueVariant: Pick<{
32
32
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
33
33
  readonly PRIMARY: "primary";
34
34
  readonly ACCENT: "accent";
35
+ readonly ACCENT_GHOST: "accent-ghost";
35
36
  readonly SUCCESS: "success";
36
37
  readonly WARNING: "warning";
37
38
  readonly DANGER: "danger";
39
+ readonly DANGER_GHOST: "danger-ghost";
40
+ readonly GHOST: "ghost";
38
41
  }, "NEUTRAL" | "ACCENT" | "SUCCESS" | "DANGER">;
39
42
  export declare class OdxKeyValue extends CustomElement {
40
43
  alignment: KeyValueAlignment;
@@ -22,9 +22,12 @@ export declare const MenuItemVariant: Pick<{
22
22
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
23
23
  readonly PRIMARY: "primary";
24
24
  readonly ACCENT: "accent";
25
+ readonly ACCENT_GHOST: "accent-ghost";
25
26
  readonly SUCCESS: "success";
26
27
  readonly WARNING: "warning";
27
28
  readonly DANGER: "danger";
29
+ readonly DANGER_GHOST: "danger-ghost";
30
+ readonly GHOST: "ghost";
28
31
  }, "NEUTRAL" | "DANGER">;
29
32
  export declare class OdxMenuItem extends LinkControlElement {
30
33
  protected loadingSpinnerSlot: "prefix";
@@ -12,9 +12,12 @@ export declare const StatusVariant: Pick<{
12
12
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
13
13
  readonly PRIMARY: "primary";
14
14
  readonly ACCENT: "accent";
15
+ readonly ACCENT_GHOST: "accent-ghost";
15
16
  readonly SUCCESS: "success";
16
17
  readonly WARNING: "warning";
17
18
  readonly DANGER: "danger";
19
+ readonly DANGER_GHOST: "danger-ghost";
20
+ readonly GHOST: "ghost";
18
21
  }, "NEUTRAL" | "PRIMARY" | "SUCCESS" | "WARNING" | "DANGER">;
19
22
  export declare class OdxStatus extends CustomElement {
20
23
  animated: boolean;
@@ -16,6 +16,7 @@ export declare const TabBarAlignment: Pick<{
16
16
  export declare class OdxTabBar extends CustomElement {
17
17
  #private;
18
18
  private readonly containerElement?;
19
+ private readonly indicatorElement?;
19
20
  private readonly scrollContainer?;
20
21
  alignment: TabBarAlignment;
21
22
  autoSelect: boolean;
@@ -26,6 +27,8 @@ export declare class OdxTabBar extends CustomElement {
26
27
  vertical: boolean;
27
28
  get selectedItem(): OdxNavigationItem | undefined;
28
29
  constructor();
30
+ connectedCallback(): void;
31
+ disconnectedCallback(): void;
29
32
  getItems(): OdxNavigationItem[];
30
33
  selectItem(item: OdxNavigationItem): void;
31
34
  selectPreviousItem(): void;
@@ -20,9 +20,12 @@ export declare const TextVariant: Pick<{
20
20
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
21
21
  readonly PRIMARY: "primary";
22
22
  readonly ACCENT: "accent";
23
+ readonly ACCENT_GHOST: "accent-ghost";
23
24
  readonly SUCCESS: "success";
24
25
  readonly WARNING: "warning";
25
26
  readonly DANGER: "danger";
27
+ readonly DANGER_GHOST: "danger-ghost";
28
+ readonly GHOST: "ghost";
26
29
  }, "NEUTRAL" | "NEUTRAL_SUBTLE" | "ACCENT" | "SUCCESS" | "DANGER">;
27
30
  export declare class OdxText extends CustomElement {
28
31
  strong: boolean;
@@ -12,9 +12,12 @@ export declare const TileVariant: Pick<{
12
12
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
13
13
  readonly PRIMARY: "primary";
14
14
  readonly ACCENT: "accent";
15
+ readonly ACCENT_GHOST: "accent-ghost";
15
16
  readonly SUCCESS: "success";
16
17
  readonly WARNING: "warning";
17
18
  readonly DANGER: "danger";
19
+ readonly DANGER_GHOST: "danger-ghost";
20
+ readonly GHOST: "ghost";
18
21
  }, "NEUTRAL">;
19
22
  export type TileAlignment = ValuesOf<typeof TileAlignment>;
20
23
  export declare const TileAlignment: Pick<{
@@ -13,9 +13,12 @@ export declare const ToastVariant: Pick<{
13
13
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
14
14
  readonly PRIMARY: "primary";
15
15
  readonly ACCENT: "accent";
16
+ readonly ACCENT_GHOST: "accent-ghost";
16
17
  readonly SUCCESS: "success";
17
18
  readonly WARNING: "warning";
18
19
  readonly DANGER: "danger";
20
+ readonly DANGER_GHOST: "danger-ghost";
21
+ readonly GHOST: "ghost";
19
22
  }, "NEUTRAL" | "PRIMARY" | "SUCCESS" | "WARNING" | "DANGER">;
20
23
  export declare class OdxToast extends CustomElement {
21
24
  icon?: OdxIconName;
@@ -8,11 +8,19 @@ declare global {
8
8
  'odx-toggle-button': OdxToggleButton;
9
9
  }
10
10
  }
11
- export type ToggleButtonAppearance = ValuesOf<typeof ToggleButtonAppearance>;
12
- export declare const ToggleButtonAppearance: Pick<{
13
- readonly FILL: "fill";
11
+ export type ToggleButtonVariant = ValuesOf<typeof ToggleButtonVariant>;
12
+ export declare const ToggleButtonVariant: Pick<{
13
+ readonly NEUTRAL: "neutral";
14
+ readonly NEUTRAL_SUBTLE: "neutral-subtle";
15
+ readonly PRIMARY: "primary";
16
+ readonly ACCENT: "accent";
17
+ readonly ACCENT_GHOST: "accent-ghost";
18
+ readonly SUCCESS: "success";
19
+ readonly WARNING: "warning";
20
+ readonly DANGER: "danger";
21
+ readonly DANGER_GHOST: "danger-ghost";
14
22
  readonly GHOST: "ghost";
15
- }, "FILL" | "GHOST">;
23
+ }, "ACCENT" | "GHOST">;
16
24
  export type ToggleButtonSize = ValuesOf<typeof ToggleButtonSize>;
17
25
  export declare const ToggleButtonSize: Pick<{
18
26
  readonly XS: "xs";
@@ -24,13 +32,13 @@ export declare const ToggleButtonSize: Pick<{
24
32
  }, "SM" | "MD" | "LG">;
25
33
  declare const OdxToggleButton_base: import('../../utils/main.js').Constructor<CheckboxControl> & typeof CustomElement;
26
34
  export declare class OdxToggleButton extends OdxToggleButton_base {
27
- appearance: ToggleButtonAppearance;
28
35
  label?: string;
29
36
  labelChecked?: string;
30
37
  labelPlacement?: TooltipPlacement;
31
38
  icon?: OdxIconName;
32
39
  iconChecked?: OdxIconName;
33
40
  size: ToggleButtonSize;
41
+ variant: ToggleButtonVariant;
34
42
  connectedCallback(): void;
35
43
  protected render(): TemplateResult;
36
44
  protected willUpdate(props: PropertyValues<this>): void;
@@ -1,6 +1,6 @@
1
1
  import { CustomElement, RadioGroupControl } from '../../main.js';
2
2
  import { PropertyValues, TemplateResult } from 'lit';
3
- import { OdxToggleButton, ToggleButtonAppearance, ToggleButtonSize } from '../toggle-button/toggle-button.js';
3
+ import { OdxToggleButton, ToggleButtonSize, ToggleButtonVariant } from '../toggle-button/toggle-button.js';
4
4
  declare global {
5
5
  interface HTMLElementTagNameMap {
6
6
  'odx-toggle-button-group': OdxToggleButtonGroup;
@@ -9,8 +9,8 @@ declare global {
9
9
  declare const OdxToggleButtonGroup_base: import('../../utils/types.js').Constructor<RadioGroupControl<OdxToggleButton>> & typeof CustomElement;
10
10
  export declare class OdxToggleButtonGroup extends OdxToggleButtonGroup_base {
11
11
  #private;
12
- appearance: ToggleButtonAppearance;
13
12
  size: ToggleButtonSize;
13
+ variant?: ToggleButtonVariant;
14
14
  constructor();
15
15
  isControl(element: HTMLElement): element is OdxToggleButton;
16
16
  protected render(): TemplateResult | string;
@@ -36,9 +36,12 @@ export declare const TooltipVariant: Pick<{
36
36
  readonly NEUTRAL_SUBTLE: "neutral-subtle";
37
37
  readonly PRIMARY: "primary";
38
38
  readonly ACCENT: "accent";
39
+ readonly ACCENT_GHOST: "accent-ghost";
39
40
  readonly SUCCESS: "success";
40
41
  readonly WARNING: "warning";
41
42
  readonly DANGER: "danger";
43
+ readonly DANGER_GHOST: "danger-ghost";
44
+ readonly GHOST: "ghost";
42
45
  }, "NEUTRAL" | "ACCENT" | "DANGER">;
43
46
  export declare class OdxTooltip extends PopoverHost {
44
47
  #private;