Skip to content

Commit 0dca72a

Browse files
authored
chore: update docs for infotext + migration (#856)
1 parent e6131c6 commit 0dca72a

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

packages/components/src/components/alert/docs/Migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
### class
99

10-
| Before | Status | After | Description |
11-
| ------------------ | :----: | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10+
| Before | Status | After | Description |
11+
| ------------------ | :----: | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1212
| `elm-notification` | 🔁 | `db-alert` | The old notification component has been split into 2 different components [Notification](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system-v3/components/feedback/notification) and [Alert](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system-v3/components/feedback/alert) for more information (when and how to use it). |
1313

1414
### variant ➡ type
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## General
2+
3+
> **Note**
4+
> For a general installation or migration process check out this [documentation](https://www.npmjs.com/package/@db-ui/components).
5+
6+
## DB UI Core ➡ DB UI Components
7+
8+
New Component 🥳

packages/components/src/components/infotext/model.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,21 @@ import {
22
DefaultVariantProps,
33
DefaultVariantType,
44
GlobalProps,
5-
GlobalState
5+
GlobalState,
6+
IconProps
67
} from '../../shared/model';
78

89
export interface DBInfotextDefaultProps {
9-
icon?: string;
10+
/**
11+
* The size attribute changes the font-size of the infotext and hides the icon for size="small".
12+
*/
1013
size?: 'medium' | 'small';
1114
}
1215

1316
export type DBInfotextProps = DBInfotextDefaultProps &
1417
GlobalProps &
15-
DefaultVariantProps;
18+
DefaultVariantProps &
19+
IconProps;
1620

1721
export interface DBInfotextDefaultState {
1822
getIcon: (icon?: string, variant?: DefaultVariantType) => string;

0 commit comments

Comments
 (0)