Skip to content

Commit 6ff4962

Browse files
DSilDSil
committed
feat(Box): remove deprecated elevation values
BREAKING CHANGE: deprecated elevation prop values were removed.
1 parent c11297b commit 6ff4962

File tree

5 files changed

+16
-62
lines changed

5 files changed

+16
-62
lines changed

‎packages/orbit-components/src/Box/README.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -144,19 +144,15 @@ All this properties - objects have the some own properties and none is required.
144144

145145
### elevation
146146

147-
| elevation |
148-
| :--------------------------------------------------------- |
149-
| `"action"` – **deprecated (use `"level1"`)** |
150-
| `"fixed"` |
151-
| `"fixedReverse"` |
152-
| `"overlay"` – **deprecated (use `"level4"`)** |
153-
| `"raised"` – **deprecated (use `"level3"`)** |
154-
| `"raisedReverse"` – **deprecated (use `"level3Reverse"`)** |
155-
| `"level1"` |
156-
| `"level2"` |
157-
| `"level3"` |
158-
| `"level3Reverse"` |
159-
| `"level4"` |
147+
| elevation |
148+
| :---------------- |
149+
| `"fixed"` |
150+
| `"fixedReverse"` |
151+
| `"level1"` |
152+
| `"level2"` |
153+
| `"level3"` |
154+
| `"level3Reverse"` |
155+
| `"level4"` |
160156

161157
### spacingObject
162158

‎packages/orbit-components/src/Box/TYPESCRIPT_TEMPLATE.template

-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ import type * as React from "react";
55
import type * as Common from "../common/types";
66

77
export type Elevation =
8-
| "action"
98
| "fixed"
10-
| "raised"
11-
| "overlay"
129
| "fixedReverse"
13-
| "raisedReverse"
1410
| "level1"
1511
| "level2"
1612
| "level3"

‎packages/orbit-components/src/Box/__tests__/index.test.tsx

+7-13
Original file line numberDiff line numberDiff line change
@@ -269,18 +269,12 @@ describe("#Box", () => {
269269

270270
const testEl = (idx: number) => render(test[idx]).getByTestId(`${dataTest}-${idx}`);
271271

272-
expect(testEl(0)).toHaveStyle({
273-
"--tw-shadow": theme.orbit.elevationActionBoxShadow,
274-
});
275-
expect(testEl(1)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationFixedBoxShadow });
276-
expect(testEl(2)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationRaisedBoxShadow });
277-
expect(testEl(3)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationOverlayBoxShadow });
278-
expect(testEl(4)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationFixedReverseBoxShadow });
279-
expect(testEl(5)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationRaisedReverseBoxShadow });
280-
expect(testEl(6)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel1BoxShadow });
281-
expect(testEl(7)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel2BoxShadow });
282-
expect(testEl(8)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel3BoxShadow });
283-
expect(testEl(9)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel3ReverseBoxShadow });
284-
expect(testEl(10)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel4BoxShadow });
272+
expect(testEl(0)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationFixedBoxShadow });
273+
expect(testEl(1)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationFixedReverseBoxShadow });
274+
expect(testEl(2)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel1BoxShadow });
275+
expect(testEl(3)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel2BoxShadow });
276+
expect(testEl(4)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel3BoxShadow });
277+
expect(testEl(5)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel3ReverseBoxShadow });
278+
expect(testEl(6)).toHaveStyle({ "--tw-shadow": theme.orbit.elevationLevel4BoxShadow });
285279
});
286280
});

‎packages/orbit-components/src/Box/helpers/tailwindClasses.ts

-28
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,8 @@ export const positionClasses: {
4040
};
4141

4242
export enum SHADOWS {
43-
ACTION = "action", // deprecated
4443
FIXED = "fixed",
45-
RAISED = "raised", // deprecated
46-
OVERLAY = "overlay", // deprecated
4744
FIXED_REVERSE = "fixedReverse",
48-
RAISED_REVERSE = "raisedReverse", // deprecated
4945
LEVEL1 = "level1",
5046
LEVEL2 = "level2",
5147
LEVEL3 = "level3",
@@ -56,76 +52,52 @@ export enum SHADOWS {
5652
export const shadowClasses: {
5753
[K in QUERIES | SHADOWS]: K extends QUERIES ? Record<SHADOWS, string> : string;
5854
} = {
59-
[SHADOWS.ACTION]: "shadow-action", // deprecated
6055
[SHADOWS.FIXED]: "shadow-fixed",
61-
[SHADOWS.RAISED]: "shadow-raised", // deprecated
62-
[SHADOWS.OVERLAY]: "shadow-overlay", // deprecated
6356
[SHADOWS.FIXED_REVERSE]: "shadow-fixed-reverse",
64-
[SHADOWS.RAISED_REVERSE]: "shadow-raised-reverse", // deprecated
6557
[SHADOWS.LEVEL1]: "shadow-level1",
6658
[SHADOWS.LEVEL2]: "shadow-level2",
6759
[SHADOWS.LEVEL3]: "shadow-level3",
6860
[SHADOWS.LEVEL3_REVERSE]: "shadow-level3-reverse",
6961
[SHADOWS.LEVEL4]: "shadow-level4",
7062
[QUERIES.LARGEDESKTOP]: {
71-
[SHADOWS.ACTION]: "ld:shadow-action", // deprecated
7263
[SHADOWS.FIXED]: "ld:shadow-fixed",
73-
[SHADOWS.RAISED]: "ld:shadow-raised", // deprecated
74-
[SHADOWS.OVERLAY]: "ld:shadow-overlay", // deprecated
7564
[SHADOWS.FIXED_REVERSE]: "ld:shadow-fixed-reverse",
76-
[SHADOWS.RAISED_REVERSE]: "ld:shadow-raised-reverse", // deprecated
7765
[SHADOWS.LEVEL1]: "ld:shadow-level1",
7866
[SHADOWS.LEVEL2]: "ld:shadow-level2",
7967
[SHADOWS.LEVEL3]: "ld:shadow-level3",
8068
[SHADOWS.LEVEL3_REVERSE]: "ld:shadow-level3-reverse",
8169
[SHADOWS.LEVEL4]: "ld:shadow-level4",
8270
},
8371
[QUERIES.DESKTOP]: {
84-
[SHADOWS.ACTION]: "de:shadow-action", // deprecated
8572
[SHADOWS.FIXED]: "de:shadow-fixed",
86-
[SHADOWS.RAISED]: "de:shadow-raised", // deprecated
87-
[SHADOWS.OVERLAY]: "de:shadow-overlay", // deprecated
8873
[SHADOWS.FIXED_REVERSE]: "de:shadow-fixed-reverse",
89-
[SHADOWS.RAISED_REVERSE]: "de:shadow-raised-reverse", // deprecated
9074
[SHADOWS.LEVEL1]: "de:shadow-level1",
9175
[SHADOWS.LEVEL2]: "de:shadow-level2",
9276
[SHADOWS.LEVEL3]: "de:shadow-level3",
9377
[SHADOWS.LEVEL3_REVERSE]: "de:shadow-level3-reverse",
9478
[SHADOWS.LEVEL4]: "de:shadow-level4",
9579
},
9680
[QUERIES.TABLET]: {
97-
[SHADOWS.ACTION]: "tb:shadow-action", // deprecated
9881
[SHADOWS.FIXED]: "tb:shadow-fixed",
99-
[SHADOWS.RAISED]: "tb:shadow-raised", // deprecated
100-
[SHADOWS.OVERLAY]: "tb:shadow-overlay", // deprecated
10182
[SHADOWS.FIXED_REVERSE]: "tb:shadow-fixed-reverse",
102-
[SHADOWS.RAISED_REVERSE]: "tb:shadow-raised-reverse", // deprecated
10383
[SHADOWS.LEVEL1]: "tb:shadow-level1",
10484
[SHADOWS.LEVEL2]: "tb:shadow-level2",
10585
[SHADOWS.LEVEL3]: "tb:shadow-level3",
10686
[SHADOWS.LEVEL3_REVERSE]: "tb:shadow-level3-reverse",
10787
[SHADOWS.LEVEL4]: "tb:shadow-level4",
10888
},
10989
[QUERIES.LARGEMOBILE]: {
110-
[SHADOWS.ACTION]: "lm:shadow-action", // deprecated
11190
[SHADOWS.FIXED]: "lm:shadow-fixed",
112-
[SHADOWS.RAISED]: "lm:shadow-raised", // deprecated
113-
[SHADOWS.OVERLAY]: "lm:shadow-overlay", // deprecated
11491
[SHADOWS.FIXED_REVERSE]: "lm:shadow-fixed-reverse",
115-
[SHADOWS.RAISED_REVERSE]: "lm:shadow-raised-reverse", // deprecated
11692
[SHADOWS.LEVEL1]: "lm:shadow-level1",
11793
[SHADOWS.LEVEL2]: "lm:shadow-level2",
11894
[SHADOWS.LEVEL3]: "lm:shadow-level3",
11995
[SHADOWS.LEVEL3_REVERSE]: "lm:shadow-level3-reverse",
12096
[SHADOWS.LEVEL4]: "lm:shadow-level4",
12197
},
12298
[QUERIES.MEDIUMMOBILE]: {
123-
[SHADOWS.ACTION]: "mm:shadow-action", // deprecated
12499
[SHADOWS.FIXED]: "mm:shadow-fixed",
125-
[SHADOWS.RAISED]: "mm:shadow-raised", // deprecated
126-
[SHADOWS.OVERLAY]: "mm:shadow-overlay", // deprecated
127100
[SHADOWS.FIXED_REVERSE]: "mm:shadow-fixed-reverse",
128-
[SHADOWS.RAISED_REVERSE]: "mm:shadow-raised-reverse", // deprecated
129101
[SHADOWS.LEVEL1]: "mm:shadow-level1",
130102
[SHADOWS.LEVEL2]: "mm:shadow-level2",
131103
[SHADOWS.LEVEL3]: "mm:shadow-level3",

‎packages/orbit-components/src/Box/types.d.ts

-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ import type * as React from "react";
55
import type * as Common from "../common/types";
66

77
export type Elevation =
8-
| "action"
98
| "fixed"
10-
| "raised"
11-
| "overlay"
129
| "fixedReverse"
13-
| "raisedReverse"
1410
| "level1"
1511
| "level2"
1612
| "level3"

0 commit comments

Comments
 (0)