From 8b30a98a8af5c0dddf2e07aa49c2c9727dbdc8c3 Mon Sep 17 00:00:00 2001 From: Victor Genaev Date: Wed, 27 Sep 2023 16:27:05 +0200 Subject: [PATCH] feat(KeyValue): deprecate component chore: update exported paths chore(docs): remove docs of deprecated components --- docs/src/__examples__/KeyValue/DEFAULT.tsx | 53 ------------------- docs/src/components/Footer.tsx | 4 +- .../09-text/keyValue/01-guidelines.mdx | 11 ---- .../09-text/keyValue/02-react.mdx | 7 --- .../03-components/09-text/keyValue/meta.yml | 3 -- .../13-responsive/desktop/01-guidelines.mdx | 30 ----------- .../13-responsive/desktop/02-react.mdx | 9 ---- .../13-responsive/desktop/meta.yml | 3 -- .../13-responsive/mobile/01-guidelines.mdx | 30 ----------- .../13-responsive/mobile/02-react.mdx | 9 ---- .../13-responsive/mobile/meta.yml | 3 -- .../src/deprecated/Desktop/README.md | 2 +- .../KeyValue/KeyValue.stories.tsx | 6 +-- .../src/{ => deprecated}/KeyValue/README.md | 2 +- .../KeyValue/__tests__/index.test.tsx | 2 +- .../{ => deprecated}/KeyValue/index.js.flow | 4 +- .../src/{ => deprecated}/KeyValue/index.tsx | 6 +-- .../src/{ => deprecated}/KeyValue/types.d.ts | 4 +- .../src/deprecated/Mobile/README.md | 2 +- packages/orbit-components/src/index.ts | 6 +-- 20 files changed, 19 insertions(+), 177 deletions(-) delete mode 100644 docs/src/__examples__/KeyValue/DEFAULT.tsx delete mode 100644 docs/src/documentation/03-components/09-text/keyValue/01-guidelines.mdx delete mode 100644 docs/src/documentation/03-components/09-text/keyValue/02-react.mdx delete mode 100644 docs/src/documentation/03-components/09-text/keyValue/meta.yml delete mode 100644 docs/src/documentation/03-components/13-responsive/desktop/01-guidelines.mdx delete mode 100644 docs/src/documentation/03-components/13-responsive/desktop/02-react.mdx delete mode 100644 docs/src/documentation/03-components/13-responsive/desktop/meta.yml delete mode 100644 docs/src/documentation/03-components/13-responsive/mobile/01-guidelines.mdx delete mode 100644 docs/src/documentation/03-components/13-responsive/mobile/02-react.mdx delete mode 100644 docs/src/documentation/03-components/13-responsive/mobile/meta.yml rename packages/orbit-components/src/{ => deprecated}/KeyValue/KeyValue.stories.tsx (89%) rename packages/orbit-components/src/{ => deprecated}/KeyValue/README.md (95%) rename packages/orbit-components/src/{ => deprecated}/KeyValue/__tests__/index.test.tsx (89%) rename packages/orbit-components/src/{ => deprecated}/KeyValue/index.js.flow (70%) rename packages/orbit-components/src/{ => deprecated}/KeyValue/index.tsx (91%) rename packages/orbit-components/src/{ => deprecated}/KeyValue/types.d.ts (79%) diff --git a/docs/src/__examples__/KeyValue/DEFAULT.tsx b/docs/src/__examples__/KeyValue/DEFAULT.tsx deleted file mode 100644 index 0598e8af95..0000000000 --- a/docs/src/__examples__/KeyValue/DEFAULT.tsx +++ /dev/null @@ -1,53 +0,0 @@ -import React from "react"; -import { KeyValue } from "@kiwicom/orbit-components"; - -export default { - Example: () => { - return ; - }, - exampleKnobs: [ - { - component: "KeyValue", - knobs: [ - { - name: "label", - type: "text", - defaultValue: "Label", - }, - { - name: "value", - type: "text", - defaultValue: "Value", - }, - { - name: "size", - type: "select", - options: ["normal", "large"], - defaultValue: "normal", - }, - { - name: "spacing", - type: "select", - defaultValue: "medium", - options: [ - "none", - "XXXSmall", - "XXSmall", - "XSmall", - "small", - "medium", - "large", - "XLarge", - "XXLarge", - ], - }, - { - name: "direction", - type: "select", - defaultValue: "row", - options: ["row", "column"], - }, - ], - }, - ], -}; diff --git a/docs/src/components/Footer.tsx b/docs/src/components/Footer.tsx index 1d84308dbd..482b888b1a 100644 --- a/docs/src/components/Footer.tsx +++ b/docs/src/components/Footer.tsx @@ -1,6 +1,6 @@ import React from "react"; import styled, { css } from "styled-components"; -import { Text, Desktop, Stack, mediaQueries } from "@kiwicom/orbit-components"; +import { Text, Stack, Hide, mediaQueries } from "@kiwicom/orbit-components"; import { Link, useStaticQuery, graphql } from "gatsby"; import Switch from "./Switch"; @@ -61,7 +61,7 @@ const StyledFooterLink = styled(Link)` `; function Dot() { - return ·; + return ·; } export default function Footer() { diff --git a/docs/src/documentation/03-components/09-text/keyValue/01-guidelines.mdx b/docs/src/documentation/03-components/09-text/keyValue/01-guidelines.mdx deleted file mode 100644 index ba228b5efd..0000000000 --- a/docs/src/documentation/03-components/09-text/keyValue/01-guidelines.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Guidelines ---- - -Simple information with provided description. - - - -## Component status - - diff --git a/docs/src/documentation/03-components/09-text/keyValue/02-react.mdx b/docs/src/documentation/03-components/09-text/keyValue/02-react.mdx deleted file mode 100644 index 3f16d7c05c..0000000000 --- a/docs/src/documentation/03-components/09-text/keyValue/02-react.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: React ---- - -import KeyValueReadme from "@kiwicom/orbit-components/src/KeyValue/README.md"; - - diff --git a/docs/src/documentation/03-components/09-text/keyValue/meta.yml b/docs/src/documentation/03-components/09-text/keyValue/meta.yml deleted file mode 100644 index e5bd8e09c6..0000000000 --- a/docs/src/documentation/03-components/09-text/keyValue/meta.yml +++ /dev/null @@ -1,3 +0,0 @@ -title: KeyValue -description: Renders simple information with provided description. -type: tabs diff --git a/docs/src/documentation/03-components/13-responsive/desktop/01-guidelines.mdx b/docs/src/documentation/03-components/13-responsive/desktop/01-guidelines.mdx deleted file mode 100644 index ba97574fab..0000000000 --- a/docs/src/documentation/03-components/13-responsive/desktop/01-guidelines.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Guidelines -redirect_from: - - /components/desktop/ ---- - -import ResponsiveSimilarContentSnippet from "snippets/responsive-similar-content.mdx"; -import ResponsiveDontHideEssentialSnippet from "snippets/responsive-dont-hide-essential.mdx"; - -## When to use - -- To offer content only on large screens. -- For expansive content that fills up space. -- To keep such content from overwhelming small screens. - -## When not to use - -- For content only on small screens---use a [Mobile component](/components/responsive/mobile/). -- For more control over what appears on different screen sizes---use a - [Hide component](/components/responsive/hide/). - -## Component status - - - -## Behavior - - - - diff --git a/docs/src/documentation/03-components/13-responsive/desktop/02-react.mdx b/docs/src/documentation/03-components/13-responsive/desktop/02-react.mdx deleted file mode 100644 index 75803d3c1b..0000000000 --- a/docs/src/documentation/03-components/13-responsive/desktop/02-react.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: React -redirect_from: - - /components/desktop/react/ ---- - -import DesktopReadMe from "@kiwicom/orbit-components/src/Desktop/README.md"; - - diff --git a/docs/src/documentation/03-components/13-responsive/desktop/meta.yml b/docs/src/documentation/03-components/13-responsive/desktop/meta.yml deleted file mode 100644 index d80f2ff8be..0000000000 --- a/docs/src/documentation/03-components/13-responsive/desktop/meta.yml +++ /dev/null @@ -1,3 +0,0 @@ -title: Desktop -description: Shows content only on desktop viewports. -type: tabs diff --git a/docs/src/documentation/03-components/13-responsive/mobile/01-guidelines.mdx b/docs/src/documentation/03-components/13-responsive/mobile/01-guidelines.mdx deleted file mode 100644 index 6293c2853d..0000000000 --- a/docs/src/documentation/03-components/13-responsive/mobile/01-guidelines.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Guidelines -redirect_from: - - /components/mobile/ ---- - -import ResponsiveSimilarContentSnippet from "snippets/responsive-similar-content.mdx"; -import ResponsiveDontHideEssentialSnippet from "snippets/responsive-dont-hide-essential.mdx"; - -## When to use - -- To offer content only on small screens. -- For tailored content that fits small spaces. -- To keep such content from getting lost on large screens. - -## When not to use - -- For content only on large screens---use a [Desktop component](/components/responsive/desktop/). -- For more control over what appears on different screen sizes---use a - [Hide component](/components/responsive/hide/). - -## Component status - - - -## Behavior - - - - diff --git a/docs/src/documentation/03-components/13-responsive/mobile/02-react.mdx b/docs/src/documentation/03-components/13-responsive/mobile/02-react.mdx deleted file mode 100644 index e81d152196..0000000000 --- a/docs/src/documentation/03-components/13-responsive/mobile/02-react.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: React -redirect_from: - - /components/mobile/react/ ---- - -import MobileReadMe from "@kiwicom/orbit-components/src/Mobile/README.md"; - - diff --git a/docs/src/documentation/03-components/13-responsive/mobile/meta.yml b/docs/src/documentation/03-components/13-responsive/mobile/meta.yml deleted file mode 100644 index 5417e5c08c..0000000000 --- a/docs/src/documentation/03-components/13-responsive/mobile/meta.yml +++ /dev/null @@ -1,3 +0,0 @@ -title: Mobile -description: Shows content only on mobile viewports. -type: tabs diff --git a/packages/orbit-components/src/deprecated/Desktop/README.md b/packages/orbit-components/src/deprecated/Desktop/README.md index faaf6901dc..fa5db66203 100644 --- a/packages/orbit-components/src/deprecated/Desktop/README.md +++ b/packages/orbit-components/src/deprecated/Desktop/README.md @@ -3,7 +3,7 @@ To implement Desktop component into your project you'll need to add the import: ```jsx -import Desktop from "@kiwicom/orbit-components/lib/Desktop"; +import Desktop from "@kiwicom/orbit-components/lib/deprecated/Desktop"; ``` After adding import into your project you can use it simply like: diff --git a/packages/orbit-components/src/KeyValue/KeyValue.stories.tsx b/packages/orbit-components/src/deprecated/KeyValue/KeyValue.stories.tsx similarity index 89% rename from packages/orbit-components/src/KeyValue/KeyValue.stories.tsx rename to packages/orbit-components/src/deprecated/KeyValue/KeyValue.stories.tsx index 1241c523da..de007119d5 100644 --- a/packages/orbit-components/src/KeyValue/KeyValue.stories.tsx +++ b/packages/orbit-components/src/deprecated/KeyValue/KeyValue.stories.tsx @@ -1,9 +1,9 @@ import * as React from "react"; import { text, select } from "@storybook/addon-knobs"; -import Clock from "../icons/Clock"; -import Stack from "../Stack"; -import { SPACINGS } from "../utils/layout/consts"; +import Clock from "../../icons/Clock"; +import Stack from "../../Stack"; +import { SPACINGS } from "../../utils/layout/consts"; import KeyValue from "."; diff --git a/packages/orbit-components/src/KeyValue/README.md b/packages/orbit-components/src/deprecated/KeyValue/README.md similarity index 95% rename from packages/orbit-components/src/KeyValue/README.md rename to packages/orbit-components/src/deprecated/KeyValue/README.md index f15a59d1cb..878aa596f5 100644 --- a/packages/orbit-components/src/KeyValue/README.md +++ b/packages/orbit-components/src/deprecated/KeyValue/README.md @@ -3,7 +3,7 @@ To implement KeyValue component into your project you'll need to add the import: ```jsx -import KeyValue from "@kiwicom/orbit-components/lib/KeyValue"; +import KeyValue from "@kiwicom/orbit-components/lib/deprecated/KeyValue"; ``` After adding import into your project you can use it simply like: diff --git a/packages/orbit-components/src/KeyValue/__tests__/index.test.tsx b/packages/orbit-components/src/deprecated/KeyValue/__tests__/index.test.tsx similarity index 89% rename from packages/orbit-components/src/KeyValue/__tests__/index.test.tsx rename to packages/orbit-components/src/deprecated/KeyValue/__tests__/index.test.tsx index 23be4fd80b..24bd6ad523 100644 --- a/packages/orbit-components/src/KeyValue/__tests__/index.test.tsx +++ b/packages/orbit-components/src/deprecated/KeyValue/__tests__/index.test.tsx @@ -1,6 +1,6 @@ import * as React from "react"; -import { render, screen } from "../../test-utils"; +import { render, screen } from "../../../test-utils"; import KeyValue from ".."; describe("KeyValue", () => { diff --git a/packages/orbit-components/src/KeyValue/index.js.flow b/packages/orbit-components/src/deprecated/KeyValue/index.js.flow similarity index 70% rename from packages/orbit-components/src/KeyValue/index.js.flow rename to packages/orbit-components/src/deprecated/KeyValue/index.js.flow index 9a1dd0c031..f97181dadf 100644 --- a/packages/orbit-components/src/KeyValue/index.js.flow +++ b/packages/orbit-components/src/deprecated/KeyValue/index.js.flow @@ -1,8 +1,8 @@ // @flow import * as React from "react"; -import type { Globals } from "../common/common.js.flow"; -import type { Spacing } from "../Stack/index.js.flow"; +import type { Globals } from "../../common/common.js.flow"; +import type { Spacing } from "../../Stack/index.js.flow"; export type Props = {| +label?: React.Node, diff --git a/packages/orbit-components/src/KeyValue/index.tsx b/packages/orbit-components/src/deprecated/KeyValue/index.tsx similarity index 91% rename from packages/orbit-components/src/KeyValue/index.tsx rename to packages/orbit-components/src/deprecated/KeyValue/index.tsx index f75b8cb359..bb1c459824 100644 --- a/packages/orbit-components/src/KeyValue/index.tsx +++ b/packages/orbit-components/src/deprecated/KeyValue/index.tsx @@ -3,9 +3,9 @@ import * as React from "react"; import styled, { css } from "styled-components"; -import defaultTheme from "../defaultTheme"; -import { SPACINGS } from "../utils/layout/consts"; -import Text from "../Text"; +import defaultTheme from "../../defaultTheme"; +import { SPACINGS } from "../../utils/layout/consts"; +import Text from "../../Text"; import type { Props } from "./types"; const getSpacing = ({ theme }) => ({ diff --git a/packages/orbit-components/src/KeyValue/types.d.ts b/packages/orbit-components/src/deprecated/KeyValue/types.d.ts similarity index 79% rename from packages/orbit-components/src/KeyValue/types.d.ts rename to packages/orbit-components/src/deprecated/KeyValue/types.d.ts index 6c8a93e364..9f850f257e 100644 --- a/packages/orbit-components/src/KeyValue/types.d.ts +++ b/packages/orbit-components/src/deprecated/KeyValue/types.d.ts @@ -2,8 +2,8 @@ // Project: http://github.com/kiwicom/orbit import type * as React from "react"; -import type * as Common from "../common/types"; -import type { Spacing } from "../Stack/types"; +import type * as Common from "../../common/types"; +import type { Spacing } from "../../Stack/types"; export interface Props extends Common.Globals { readonly label?: React.ReactNode; diff --git a/packages/orbit-components/src/deprecated/Mobile/README.md b/packages/orbit-components/src/deprecated/Mobile/README.md index 55d4ae5537..b532385fab 100644 --- a/packages/orbit-components/src/deprecated/Mobile/README.md +++ b/packages/orbit-components/src/deprecated/Mobile/README.md @@ -3,7 +3,7 @@ To implement Mobile component into your project you'll need to add the import: ```jsx -import Mobile from "@kiwicom/orbit-components/lib/Mobile"; +import Mobile from "@kiwicom/orbit-components/lib/deprecated/Mobile"; ``` After adding import into your project you can use it simply like: diff --git a/packages/orbit-components/src/index.ts b/packages/orbit-components/src/index.ts index 24580496ad..7098979ac1 100644 --- a/packages/orbit-components/src/index.ts +++ b/packages/orbit-components/src/index.ts @@ -19,7 +19,7 @@ export { default as Checkbox } from "./Checkbox"; export { default as ChoiceGroup } from "./ChoiceGroup"; export { default as Collapse } from "./Collapse"; export { default as CountryFlag } from "./CountryFlag"; -export { default as Desktop } from "./Desktop"; +export { default as Desktop } from "./deprecated/Desktop"; export { default as Dialog } from "./Dialog"; export { default as FeatureIcon } from "./FeatureIcon"; export { default as NotificationBadge } from "./NotificationBadge"; @@ -74,11 +74,11 @@ export { ItinerarySegmentStop, ItinerarySegmentDetail, } from "./Itinerary"; -export { default as KeyValue } from "./KeyValue"; +export { default as KeyValue } from "./deprecated/KeyValue"; export { default as List, ListItem } from "./List"; export { default as ListChoice } from "./ListChoice"; export { default as Loading } from "./Loading"; -export { default as Mobile } from "./Mobile"; +export { default as Mobile } from "./deprecated/Mobile"; export { default as Pagination } from "./Pagination"; export { default as Popover } from "./Popover"; export { default as Radio } from "./Radio";