Skip to content

Commit 0d62346

Browse files
docs: remove "design system" term usage (#1267)
1 parent b988eec commit 0d62346

File tree

8 files changed

+15
-14
lines changed

8 files changed

+15
-14
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Element Framework is using monorepo. This repository has elements, supporting mo
2626
- `packages/core` - Core module of element e.g. base classes, element registration
2727
- `packages/create-efx` - Initializer for creating a new EFX elements
2828
- `packages/demo-block` - Use in demo page of each element to demonstrate element's features
29-
- `packages/elemental-theme` - Base theme to extend to design system theme e.g. Halo Theme
29+
- `packages/elemental-theme` - Base theme to extend to LSEG Workspace theme e.g. Halo Theme
3030
- `packages/elements` - All elements in Element Framework
31-
- `packages/halo-theme` - LSEG Workspace design system theme
31+
- `packages/halo-theme` - LSEG Workspace theme
3232
- `packages/i18n` - Wrappers and APIs of formatjs
3333
- `packages/phrasebook` - All messages (english and non-english) that use within elements
3434
- `packages/solar-theme` - Legacy theme

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=refinitiv_refinitiv-ui&metric=coverage&branch=v7)](https://sonarcloud.io/summary/new_code?id=refinitiv_refinitiv-ui&branch=v7)
44
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=refinitiv_refinitiv-ui&metric=vulnerabilities&branch=v7)](https://sonarcloud.io/summary/new_code?id=refinitiv_refinitiv-ui&branch=v7)
55

6-
Element Framework is LSEG Workspace's design system components that provides components and tooling to help product teams work faster and more efficiently.
6+
Element Framework is LSEG Workspace standardised components that provides components and tooling to help product teams work faster and more efficiently.
77

88
# Documentation
99

documents/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ o> ![translate version](https://img.shields.io/npm/v/@refinitiv-ui/translate/%np
1919
o> ![utils version](https://img.shields.io/npm/v/@refinitiv-ui/utils/%npm_dist_tag%?color=%2339c46e&label=utils)
2020
o>
2121

22-
Element Framework (EF) provides components and tooling, aligned with LSEG Workspace's design system, to help developers build applications faster and more efficiently.
22+
Element Framework (EF) provides components and tooling, aligned with LSEG Workspace standardised components, to help developers build applications faster and more efficiently.
2323

2424
Components are built using technology native to the browser, allowing them to be lightweight and work with any web framework.
2525

26-
## Design System
26+
## Standardised Components
2727

2828
Built on a solid foundation, Element Framework is able to adapt to the needs of your design. Components bring in visual, functional and developmental consistency to your products and development practices.
2929

documents/src/pages/accessibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ While some Element Framework components may not be fully compatible with screen
104104

105105
## Other assistive technologies
106106

107-
Be aware that there are myriad assistive technologies that users may employ to help them access a computing device. For example, Dragon Naturally Speaking for processing voice commands or Dolphin SuperNova and ZoomText for magnification. Touch-screen devices also pose unique challenges. As we advance the accessibility features of the Halo Design System, technologies like these will increasingly be supported.
107+
Be aware that there are myriad assistive technologies that users may employ to help them access a computing device. For example, Dragon Naturally Speaking for processing voice commands or Dolphin SuperNova and ZoomText for magnification. Touch-screen devices also pose unique challenges. As we advance the accessibility features of LSEG Workspace standardised components, technologies like these will increasingly be supported.
108108

109109
## Useful resources
110110

documents/src/pages/elements/efx-grid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ EFX Grid element and extensions are published under single package.
2323
npm install @refinitiv-ui/efx-grid
2424
```
2525

26-
The element is required theme to instantiate itself in the app. LSEG Workspace's design system is called Halo theme and you can install it from npm command.
26+
The element is required theme to instantiate itself in the app. LSEG Workspace theme is called Halo theme and you can install it from npm command.
2727

2828
```bash
2929
npm install @refinitiv-ui/halo-theme
@@ -35,7 +35,7 @@ See list of APIs, demo and more usage guide by visiting [EFX Grid document](http
3535

3636
## Usage
3737

38-
Import EFX Grid and its themes into your application. To follow LSEG Workspace design system, it is required styles of some native elements e.g. typography.
38+
Import EFX Grid and its themes into your application. To follow LSEG Workspace standardised components, it is required styles of some native elements e.g. typography.
3939

4040
```javascript
4141
// import element and its Halo dark theme

documents/src/pages/start/styling.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ layout: default
77

88
# Applying Styles
99

10-
Applications in LSEG Workspace should use the Halo Design System theme to be fully compliant with branding guidelines. EF elements require their themes to be loaded in order to initialise successfully.
10+
Applications in LSEG Workspace should use the Halo theme to be fully compliant with branding guidelines. EF elements require their themes to be loaded in order to initialise successfully.
1111

1212
## Halo Theme
13-
The Halo Design System theme is provided with two variants; light and dark. An application can use only one variant while the app is running. See [Theme Switching](/guides/theme-switching) to learn how to toggle between light and dark themes in your application.
13+
14+
Halo theme provides two variants; light and dark. An application can use only one variant while the app is running. See [Theme Switching](/guides/theme-switching) to learn how to toggle between light and dark themes in your application.
1415

1516
### Native styles
1617

documents/src/pages/styles/typography.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ layout: default
77

88
# Typography
99

10-
In accordance with LSEG Workspace's Halo Design System, the default font in your application should be Proxima Nova Fin. The font is a custom font created for Workspace that has been exhaustively researched and tested with users to support a superior reading experience. It will be applied automatically when you import native styles from EF themes.
10+
In accordance with LSEG Workspace standardised components, the default font in your application should be Proxima Nova Fin. The font is a custom font created for Workspace that has been exhaustively researched and tested with users to support a superior reading experience. It will be applied automatically when you import native styles from EF themes.
1111

1212
For Japanese, Traditional Chinese, and Simplified Chinese, Halo theme has defined a standard font to be used for those languages. However, if the font is not available on users machine, default font that managed by operation system on user's machine will be used.
1313

packages/elements/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Element Framework
22

3-
Element Framework (EF) is a collection of elements that includes theming capability within the LSEG Workspace's design system. The elements are a set of web components which is a standard web technology and can be utilized across all browsers.
3+
Element Framework (EF) is a collection of elements that includes theming capability within the LSEG Workspace standardised components. The elements are a set of web components which is a standard web technology and can be utilized across all browsers.
44

55
## Usage
66

@@ -10,13 +10,13 @@ EF elements are published under single package.
1010
npm install @refinitiv-ui/elements
1111
```
1212

13-
The elements are required theme to instantiate itself in the app. LSEG Workspace's design system is called Halo theme and you can install it from npm command.
13+
The elements require a theme to instantiate itself in the app. LSEG Workspace theme is called Halo theme and you can install it from npm command.
1414

1515
```sh
1616
npm install @refinitiv-ui/halo-theme
1717
```
1818

19-
Finally, import both elements that you want to use and its themes into your application and it is ready to go. To follow LSEG Workspace's design system, it is required styles of some native elements e.g. typography.
19+
Finally, import both elements that you want to use and its themes into your application and it is ready to go. To follow LSEG Workspace standardised components, it is required styles of some native elements e.g. typography.
2020

2121
<br>
2222

0 commit comments

Comments
 (0)