Skip to content

Updates to Halstack documentation #1750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 30, 2024
Merged

Updates to Halstack documentation #1750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8391600
Updates to Halstack documentation
GomezIvann Dec 26, 2023
78d2826
More updates to the halstack website
GomezIvann Jan 10, 2024
d7d7f5e
Replacing wrong icon
GomezIvann Jan 10, 2024
2e8bb87
Merge branch 'master' into gomezivann/website-updates
GomezIvann Jan 22, 2024
81dd5b4
Updating internal links
GomezIvann Jan 22, 2024
6b4deb9
Merge branch 'master' into gomezivann/website-updates
raquelarrojo Jan 25, 2024
e4ff185
Updates based on feedback
GomezIvann Jan 26, 2024
18ec176
Updates based on feedback
GomezIvann Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/src/chip/Chip.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ const ChipPrefixFocused = () => (
const ChipSuffixFocused = () => (
<ExampleContainer>
<Title title="Chip with suffix" theme="light" level={4} />
<DxcChip label="Chip with suffix" suffixIcon="https://icons-for-free.com/download-icon-close+icon-1320184117228553763_512.png" onClickSuffix={() => {}} />
<DxcChip label="Chip with suffix" suffixIcon="https://cdn.iconscout.com/icon/free/png-256/free-delete-2902143-2411575.png" onClickSuffix={() => {}} />
</ExampleContainer>
);

Expand Down
2 changes: 1 addition & 1 deletion lib/src/common/coreTokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Halstack Color Palette
* @link https://developer.dxc.com/halstack/next/principles/color/usage/#color-tokens-core-color-tokens
* @link https://developer.dxc.com/halstack/next/principles/color/#color-tokens-core-color-tokens
*/
const CoreColorTokens = {
// Color
Expand Down
15 changes: 15 additions & 0 deletions website/pages/principles/color.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import Head from "next/head";
import ColorPage from "../../screens/principles/color/ColorPage";

const Color = () => {
return (
<>
<Head>
<title>Color — Halstack Design System</title>
</Head>
<ColorPage></ColorPage>
</>
);
};

export default Color;
21 changes: 0 additions & 21 deletions website/pages/principles/color/index.tsx
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions website/pages/principles/color/usage.tsx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion website/screens/common/componentList.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ exports.componentsList = [
status: "Ready",
},
{ label: "Bleed", path: "/components/bleed", status: "Ready" },
{ label: "Box", path: "/components/box", status: "Ready" },
{ label: "Box", path: "/components/box", status: "Deprecated" },
{
label: "Bulleted List",
path: "/components/bulleted-list",
Expand Down
13 changes: 12 additions & 1 deletion website/screens/components/box/BoxPageLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import { DxcParagraph, DxcFlex } from "@dxc-technology/halstack-react";
import {
DxcParagraph,
DxcFlex,
DxcAlert,
DxcLink,
} from "@dxc-technology/halstack-react";
import PageHeading from "@/common/PageHeading";
import TabsPageHeading from "@/common/TabsPageLayout";
import ComponentHeading from "@/common/ComponentHeading";
Expand All @@ -22,6 +27,12 @@ const BoxPageHeading = ({ children }: { children: React.ReactNode }) => {
organize the webpage is by using groups of related content, this can
be achieved by using a dedicated Box component.
</DxcParagraph>
<DxcAlert type="warning" size="fillParent">
This component will be removed from Halstack Design System in the future.
Please consider the new{" "}
<DxcLink href="/components/container">Container</DxcLink> component
as an alternative for your current use cases.
</DxcAlert>
<TabsPageHeading tabs={tabs}></TabsPageHeading>
</DxcFlex>
</PageHeading>
Expand Down
2 changes: 1 addition & 1 deletion website/screens/components/container/code/ContainerCodePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const sections = [
being <Code>CoreColorTokens</Code> the color tokens provided by
Halstack Design System. See our{" "}
<Link
href="/principles/color/usage/#color-tokens-core-color-tokens"
href="/principles/color/#color-tokens-core-color-tokens"
passHref
legacyBehavior
>
Expand Down
45 changes: 5 additions & 40 deletions website/screens/components/heading/specs/HeadingSpecsPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,11 @@ const sections = [
<td>
<Code>font-style</Code>
</td>
<td>regular</td>
<td>normal</td>
<td>
<Code>font-normal</Code>
</td>
</tr>
<tr>
<td>
<Code>text-transform</Code>
</td>
<td>initial</td>
<td></td>
</tr>
<tr>
<td>
<Code>letter-spacing</Code>
Expand Down Expand Up @@ -138,18 +131,11 @@ const sections = [
<td>
<Code>font-style</Code>
</td>
<td>regular</td>
<td>normal</td>
<td>
<Code>font-normal</Code>
</td>
</tr>
<tr>
<td>
<Code>text-transform</Code>
</td>
<td>initial</td>
<td></td>
</tr>
<tr>
<td>
<Code>letter-spacing</Code>
Expand Down Expand Up @@ -206,18 +192,11 @@ const sections = [
<td>
<Code>font-style</Code>
</td>
<td>regular</td>
<td>normal</td>
<td>
<Code>font-normal</Code>
</td>
</tr>
<tr>
<td>
<Code>text-transform</Code>
</td>
<td>initial</td>
<td></td>
</tr>
<tr>
<td>
<Code>letter-spacing</Code>
Expand Down Expand Up @@ -274,18 +253,11 @@ const sections = [
<td>
<Code>font-style</Code>
</td>
<td>regular</td>
<td>normal</td>
<td>
<Code>font-normal</Code>
</td>
</tr>
<tr>
<td>
<Code>text-transform</Code>
</td>
<td>initial</td>
<td></td>
</tr>
<tr>
<td>
<Code>letter-spacing</Code>
Expand Down Expand Up @@ -342,18 +314,11 @@ const sections = [
<td>
<Code>font-style</Code>
</td>
<td>regular</td>
<td>normal</td>
<td>
<Code>font-normal</Code>
</td>
</tr>
<tr>
<td>
<Code>text-transform</Code>
</td>
<td>initial</td>
<td></td>
</tr>
<tr>
<td>
<Code>letter-spacing</Code>
Expand Down
2 changes: 1 addition & 1 deletion website/screens/components/typography/TypographyPageLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import PageHeading from "@/common/PageHeading";
import { DxcHeading, DxcFlex, DxcAlert } from "@dxc-technology/halstack-react";
import { DxcFlex, DxcAlert } from "@dxc-technology/halstack-react";
import TabsPageHeading from "@/common/TabsPageLayout";
import ComponentHeading from "@/common/ComponentHeading";

Expand Down
31 changes: 10 additions & 21 deletions ...principles/color/usage/ColorUsagePage.tsx → ...te/screens/principles/color/ColorPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
DxcFlex,
DxcLink,
DxcParagraph,
DxcHeading,
} from "@dxc-technology/halstack-react";
import Figure from "@/common/Figure";
import Image from "@/common/Image";
Expand All @@ -12,6 +13,7 @@ import Code from "@/common/Code";
import QuickNavContainerLayout from "@/common/QuickNavContainerLayout";
import colorOverview from "./images/color_overview.png";
import colorFamilies from "./images/color_families.png";
import PageHeading from "@/common/PageHeading";

const sections = [
{
Expand Down Expand Up @@ -820,38 +822,25 @@ const sections = [
},
],
},
{
title: "Dark mode",
subSections: [
{
title: "BackgroundColorProvider",
content: (
<>
<DxcParagraph>
The Design System components have two versions, 'onDark' and
'onLight' to ensure that they are displayed correctly regardless
of their background. This is not two different themes of the same
component but a way to ensure correct display.
</DxcParagraph>
</>
),
},
],
},
];

const ColorUsagePage = () => {
const ColorPage = () => {
return (
<DxcFlex direction="column" gap="4rem">
<PageHeading>
<DxcFlex direction="column" gap="2rem">
<DxcHeading level={1} text="Color" weight="bold"></DxcHeading>
</DxcFlex>
</PageHeading>
<QuickNavContainerLayout>
<QuickNavContainer
sections={sections}
startHeadingLevel={2}
></QuickNavContainer>
</QuickNavContainerLayout>
<DocFooter githubLink="https://github.com/dxc-technology/halstack-react/blob/master/website/screens/principles/color/usage/ColorUsagePage.tsx" />
<DocFooter githubLink="https://github.com/dxc-technology/halstack-react/blob/master/website/screens/principles/color/ColorPage.tsx" />
</DxcFlex>
);
};

export default ColorUsagePage;
export default ColorPage;
31 changes: 0 additions & 31 deletions website/screens/principles/color/ColorPageLayout.tsx
View file
Open in desktop

This file was deleted.

72 changes: 0 additions & 72 deletions website/screens/principles/color/code/ColorCodePage.tsx
View file
Open in desktop

This file was deleted.

Loading