Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
d0db846
Add transparent variants to greyscale family
aweell Nov 30, 2021
993817a
Remove backticks from RGBA values column
aweell Nov 30, 2021
38f03de
Update alpha tokens for overlay and action states
aweell Nov 30, 2021
ec74855
Change rgba() value letters to lowercase
aweell Nov 30, 2021
b52af4c
Changes on hsla notation
aweell Nov 30, 2021
7ad0510
Update overlayColor core token and value
aweell Nov 30, 2021
ed998d8
Merge branch 'principles-color-neutral-a-tokens' of https://github.co…
aweell Nov 30, 2021
526300e
Add accessibility section
aweell Dec 2, 2021
9d0241d
Remove widget attributes
aweell Dec 2, 2021
67a27e4
Merge pull request #633 from dxc-technology/component-button
aweell Dec 2, 2021
cfe859e
Merge pull request #630 from dxc-technology/principles-color-neutral-…
aweell Dec 3, 2021
ec0487d
Update `font-leading-loose-01` description field
aweell Dec 7, 2021
81e1185
Remove headings from `principles/typography` documentation
aweell Dec 7, 2021
3945533
Update core token naming
aweell Dec 7, 2021
ce54e08
Update body styles
aweell Dec 7, 2021
af33cde
Add body type set image
aweell Dec 7, 2021
ca70d70
Update additional styles specs
aweell Dec 7, 2021
1da5c67
Update images and added XD file
aweell Dec 7, 2021
a9f8aba
Fix on headings image path
aweell Dec 7, 2021
aecb74a
Merge pull request #639 from dxc-technology/principles-typography
aweell Dec 7, 2021
900fe33
Add `font-family-mono` core token
aweell Dec 9, 2021
2471725
Add accessibility section
aweell Dec 9, 2021
22c7468
Merge pull request #640 from dxc-technology/principles-type
aweell Dec 10, 2021
2d5a31e
Merge pull request #641 from dxc-technology/master
aweell Dec 10, 2021
737d036
Add content, design and image pages
aweell Dec 10, 2021
2039538
Update catalog.json and docs image paths
aweell Dec 10, 2021
390c786
Update overview
aweell Dec 10, 2021
8be97c2
Merge pull request #642 from dxc-technology/contributing-docs
aweell Dec 13, 2021
46b5e73
Update UI-Kit version
aweell Dec 13, 2021
4db1625
Update changelog
aweell Dec 13, 2021
132ff6b
Fixes on UI Kit
aweell Dec 15, 2021
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
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Changelog

## 3.13.0 (26/11/2021)
## What's Changed
* [Contribution] Update feedback section by @aweell in https://github.com/dxc-technology/halstack-style-guide/pull/622
* [Toggle] Toggle design review by @aweell in https://github.com/dxc-technology/halstack-style-guide/pull/613
* [Principles] Changes on token leading values by @aweell in https://github.com/dxc-technology/halstack-style-guide/pull/625
* [Slider] Add label and helper text by @aweell in https://github.com/dxc-technology/halstack-style-guide/pull/620


**Full Changelog**: https://github.com/dxc-technology/halstack-style-guide/compare/3.12.0...3.13.0
---

## 3.12.0 (16/11/2021)
## What's Changed

Expand Down
Binary file added Halstack UI-Kit/UI_kit_Halstack_v3.14.0.xd
Binary file not shown.
Binary file not shown.
12 changes: 12 additions & 0 deletions guidelines/catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,18 @@
{
"key": "overview",
"name": "Overview"
},
{
"key": "content",
"name": "Content"
},
{
"key": "image",
"name": "Image"
},
{
"key": "design",
"name": "Design"
}
]
}
6 changes: 3 additions & 3 deletions guidelines/components/alert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ Depending on the content that need to be displayed, more detailed descriptions c
| `errorBorderColor` | Container border | `color-red-700` | #d0011b |
| `titleFontColor` | Title | `color-black` | #000000 |
| `inlineTextFontColor` | Inline text | `color-black` | #000000 |
| `hoverActionBackgroundColor` | Action:hover | - | #0000000d |
| `activeActionBackgroundColor` | Action:active | - | #0000001a |
| `hoverActionBackgroundColor` | Action:hover | `color-grey-100-a` | #0000000d |
| `activeActionBackgroundColor` | Action:active | `color-grey-200-a` | #0000001a |
| `focusActionBorderColor` | Action:focus | `color-blue-600` | #0095ff |
| `overlayColor` | Overlay | - | #000000B3 |
| `overlayColor` | Overlay | `color-grey-800-a` | #000000b3 |


### Typography
Expand Down
6 changes: 6 additions & 0 deletions guidelines/components/button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,12 @@ Any icon can be used in Halstack Design System, so it is apt to the user to choo

_Icon usage examples_

## Accessibility

* Understanding WCAG 2.2 - [2.4.7: Focus Visible](https://www.w3.org/WAI/WCAG22/Understanding/focus-visible)
* Understanding WCAG 2.2 - [3.2.2: On Input](https://www.w3.org/WAI/WCAG22/Understanding/on-input)
* WAI-ARIA Authoring Practices 1.2 -[Button Design Pattern](https://www.w3.org/TR/wai-aria-practices-1.2/#button)

## Links and references

* [Angular CDK component](https://developer.dxc.com/tools/react/next/#/components/button)
Expand Down
2 changes: 1 addition & 1 deletion guidelines/components/dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ _Design specifications for dialog component_

| Component token | Element | Core token | Value |
| :----------------------------- | :------------------------- | :--------------------------- | :-------------------- |
| `overlayColor` | Overlay | `color-black` | #000000 |
| `overlayColor` | Overlay | `color-grey-800-a` | #000000b3 |
| `backgroundColor` | Container | `color-white` | #ffffff |
| `boxShadowColor` | Container shadow | - | rgba(0, 0, 0, 0.2) |
| `closeIconColor` | Icon close | `color-black` | #000000 |
Expand Down
20 changes: 10 additions & 10 deletions guidelines/components/header/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ _Header design specifications_

### Color

| Component token | Element | Core token | Value |
| :----------------------------- | :--------------- | :--------------- | :--------- |
| `backgroundColor` | Container | `color-white` | #ffffff |
| `underlinedColor` | Container | `color-black` | #000000 |
| `hamburguerHoverColor` | Menu:hover | `color-grey-700` | #666666 |
| `hamburguerFocusColor` | Menu:focus | `color-blue-600` | #0095ff |
| `hamburguerFontColor` | Menu label | `color-black` | #000000 |
| `hamburguerIconColor` | Menu icon | `color-black` | #000000 |
| `menuBackgroundColor` | Menu | `color-white` | #ffffff |
| `overlayColor` | Overlay | `color-black` | #f2f2f2 |
| Component token | Element | Core token | Value |
| :----------------------------- | :--------------- | :---------------------- | :---------- |
| `backgroundColor` | Container | `color-white` | #ffffff |
| `underlinedColor` | Container | `color-black` | #000000 |
| `hamburguerHoverColor` | Menu:hover | `color-grey-700` | #666666 |
| `hamburguerFocusColor` | Menu:focus | `color-blue-600` | #0095ff |
| `hamburguerFontColor` | Menu label | `color-black` | #000000 |
| `hamburguerIconColor` | Menu icon | `color-black` | #000000 |
| `menuBackgroundColor` | Menu | `color-white` | #ffffff |
| `overlayColor` | Overlay | `color-grey-800-a` | #000000b3 |

### Typography

Expand Down
2 changes: 1 addition & 1 deletion guidelines/components/progressbar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ _Component design specifications_
| `indicatorFontColorOnDark` | Indicator | `color-white` | #ffffff |
| `helperFontColor` | Helper text | `color-black` | #000000 |
| `helperFontColorOnDark` | Helper text | `color-white` | #ffffff |
| `overlayColor` | Overlay | - | #000000 0.80 opacity |
| `overlayColor` | Overlay | `color-grey-800-a` | #000000b3 |

### Size

Expand Down
2 changes: 1 addition & 1 deletion guidelines/components/spinner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ _Spinner design specifications_
| `fontColor` | Label | `color-black` | #000000 |
| `fontColorOnDark` | Label | `color-white` | #ffffff |
| `fontColor` | Percentage | `color-black` | #000000 |
| `overlayColor` | Overlay | - | #000000 0.80 opacity |
| `overlayColor` | Overlay | `color-grey-800-a` | #000000b3 |


### Size
Expand Down
197 changes: 197 additions & 0 deletions guidelines/contributing/content/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
# Content

## Markdown

Our documentation pages are written in markdown. [Check the markdown guide for the basic syntax](https://www.markdownguide.org/basic-syntax/).

## Writing content

* Keep sentences and paragraphs short and focused.
* Be clear and concise by removing unnecessary words.
* Use sentence case for everything, including component names

## Sections

Our components documentation is divided in 4 main different sections:

* **Introduction**: Brief description of the component.
* **Usage**: How the component should be used.
* **Anatomy**: All the individual elements that are part of the component.
* **Design specs**: How the component is built.

Other sections to consider adding to a component documentation:

* States
* Variants
* Placement and aligment
* Behavior and interaction
* Content
* Accessibility

You can check out our [templates](https://github.com/dxc-technology/halstack-style-guide/blob/contribution-content/contributing/template.md) for component and patterns documentation.

### Creating hierarchy

All documentation pages should follow the same hierarchy:

| Item | Purpose | Markdown syntax |
| ---------- | ----------------------------- | --------------- |
| `h1` | Component or principle name | `#` |
| `h2` | General sections | `##` |
| `h3` | Subsections | `###` |
| `h4`, `h5` | Any needed subdivisions | `####`, `#####` |


The title and sections for every page follow the same syntax across all our documentation. You can check a more complete [heading markdown syntax guide](https://www.markdownguide.org/basic-syntax/#headings). Below you can find an example of how one of our component documentation hierarchy is built:

```

# Select
## Usage
## States
### Text-input
### Options list
## Anatomy
## Design specs
## Accesibility

```
_Example of a component documentation page headings hierarchy_

### Heading anchors

In order to provide a way to navigate through the documentation pages anchor links are used.

* Anchor links are placed after the title of the component and the general description
* The anchors only should be created for second-level headings (`##`)

```
* [Usage](#usage)
* [Formatting](#formatting)
* [Anatomy](#anatomy)
* [Placement and alignment](#placement-and-alignment)
* [Behavior and interaction](#behavior-and-interaction)
* [Content](#content)
* [Design specifications](#design-specifications)
* [Accessibility](#accessibility)
```
_Example of an anchor links section_

### Bottom links

Every page should have a dedicated section at the bottom with related links, in this section are included:

* **Angular CDK component**: link to the latest released angular component. [Angular CDK documentation](https://developer.dxc.com/tools/angular/)
* **React CDK component**: link to the latest released react component. [React CDK documentation](https://developer.dxc.com/tools/react/)
* **Adobe XD component**: link to the latest Adobe XD view component page
* **Edit this page in GitHub**: link to the `README.md` of the page in the master branch

Use the following template to add the “links and references“ section to any documentation page:

```

## Links and references

* [Angular CDK component]()
* [React CDK component]()
* [Adobe XD component]()

_________________________

[Edit this page on GitHub]()

```

_Example of the “links and references“ section_

## Anatomy

The anatomy section helps users and developers to understand the building blocks of a component and provides information abour the naming of the elements. This section basically consists of an image and a list of elements.

* Number the anatomy markers from left to right and from top to bottom
* When an element is optional, point it out in its list reference
* When choosing the component image, try to provide the component that has all the possible elements present, when it is not possible, use two examples

Use the following template to add the section:

```
## Anatomy

![Image Alt text]()

1. Element 01
2. Element 02 _(Optional)_
3. Element 03
```
_Example of the “anatomy“ section_

## Design specifications

When writing design specifications consider the following:

* Add a [support image](https://developer.dxc.com/design/guidelines/contributing/images) as the first item of the component specifications.
* Subdivide the component specs regarding the property (e.g. color, size, typography)

### Spec tables

Design specifications are written mainly based on tables, in order to be consistent across all our documentation pages:

* Use lowercase when referencing HEX values (#ffffff instead of #FFFFFF)
* Use scape backticks for property `items` and `tokens`
* Use sentence case (except items contained by space backticks)
* Lenght values should include both pixels and rems and follow the naming convention #px/#rem (replace rems for the more convenient relative unit)


Example of a component specs table:

```

| Property | Element | Core token | Value |
| :-------------- | :--------------- | :---------- | :-------- |
| `property-1` | Element-1 | `token-1` | value-1 |
| `property-2` | Element-2 | `token-2` | value-2 |
| `property-3` | Element-3 | `token-3` | value-3 |

```
If the component has specific tokens for the properties that affect the elements listed use them instead:

```

| Component token | Element | Core token | Value |
| :---------------- | :--------------- | :---------- | :-------- |
| `token-1` | Element-1 | `token-1` | value-1 |
| `token-2` | Element-2 | `token-2` | value-2 |
| `token-3` | Element-3 | `token-3` | value-3 |

```

Appart from the component specs, the principles and layout-patterns pages also should contain specification tables.

Example of a core tokens specs table:

```

| Token | Description | Property | Value |
| ----------- | -------------------- | -------------- | --------- |
| `token-1` | _Brief description_ | `property-1` | value-1 |
| `token-2` | _Brief description_ | `property-2` | value-2 |
| `token-3` | _Brief description_ | `property-3` | value-3 |

```

## Accessibility

The accessibility section provides all the resources needed in order to build accessible components, we follow the [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/TR/WCAG22/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) guidelines.

Every component documentation page should provide:

* All the Success Criterion<sup>1</sup> that may apply to the component behavior
* The WAI-ARIA design pattern and example


1: Every Succes Criterion should be linked to their reference inside [Understanding WCAG 2.1](https://www.w3.org/WAI/WCAG21/Understanding/) document. Learn more about Success criteria in the [WCAG Understanding conformance page](https://www.w3.org/WAI/WCAG21/Understanding/conformance#levels).

### Referencing and linking

When referencing and linking to guidelines or other technical documents ensure you are following the [W3C recommendation](https://www.w3.org/WAI/standards-guidelines/linking/:)

Loading