You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,43 @@
1
-
# Gov IE Design System
1
+
# Gov IE Frontend
2
2
3
-
Gov IE DS contains the code you need to start building a user interface for government platforms and services.
3
+
Gov IE Frontend contains the code you need to start building a user interface for government platforms and services.
4
4
5
-
See live examples of Gov IE components, and guidance on when to use them in your service, in the [Gov IE Design System](https://ogcio.github.io/ogcio-ds/).
5
+
See live examples of Gov IE components, and guidance on when to use them in your service, in the [Gov IE Frontend](https://ogcio.github.io/ogcio-ds/).
6
6
7
7
## Contact the team
8
8
9
-
If you want to know more about Gov IE Design System, you can go to the [Contact us](https://www.design-system.ogcio.gov.ie/contact/) page.
9
+
If you want to know more about Gov IE Frontend, you can go to the [Contact us](https://www.design-system.ogcio.gov.ie/contact/) page.
10
10
11
11
## Quick start
12
12
13
-
There are 2 ways to start using Gov IE Design System components in your app.
13
+
There are 2 ways to start using Gov IE Frontend components in your app.
14
14
15
-
Once installed, you will be able to use the code from the examples in the Gov IE Design System in your service.
15
+
Once installed, you will be able to use the code from the examples in the Gov IE Frontend in your service.
16
16
17
17
### 1. Install with npm (recommended)
18
18
19
-
We recommend [installing Gov IE Design System using node package manager
19
+
We recommend [installing Gov IE Frontend using node package manager
You can also install Gov IE Design System by [copying our CSS, JavaScript and asset files into your project](https://ogcio.github.io/ogcio-ds/?path=/docs/docs-install-using-precompiled-files--docs).
24
+
You can also install Gov IE Frontend by [copying our CSS, JavaScript and asset files into your project](https://ogcio.github.io/ogcio-ds/?path=/docs/docs-install-using-precompiled-files--docs).
25
25
26
26
## Accessibility
27
27
28
-
The Gov IE DS team works hard to ensure that Gov IE DS is accessible.
28
+
The Gov IE Frontend team works hard to ensure that Gov IE Frontend is accessible.
29
29
30
30
Using Frontend will help your service meet [level AA of WCAG 2.1](https://www.w3.org/TR/WCAG21/). But you must still check that your service meets accessibility requirements, especially if you extend or modify components.
31
31
32
32
You should also use:
33
33
34
-
-[the JavaScript from Gov IE DS](https://ogcio.github.io/ogcio-ds/?path=/docs/docs-import-css-assets-and-javascript--docs)
34
+
-[the JavaScript from Gov IE Frontend](https://ogcio.github.io/ogcio-ds/?path=/docs/docs-import-css-assets-and-javascript--docs)
35
35
36
-
You can also read the [accessibility statement for Gov IE DS](https://www.design-system.ogcio.gov.ie/accessibility/)
36
+
You can also read the [accessibility statement for Gov IE Frontend](https://www.design-system.ogcio.gov.ie/accessibility/)
37
37
38
38
## Getting updates
39
39
40
-
To be notified when there’s a new release, you can [watch the Gov IE DS Github repository](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)
40
+
To be notified when there’s a new release, you can [watch the Gov IE Frontend Github repository](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)
41
41
42
42
Find out how to [update with npm](https://ogcio.github.io/ogcio-ds/?path=/story/docs-update-with-npm--docs/).
43
43
@@ -127,7 +127,7 @@ To uninstall Husky hooks, run the following command:
127
127
npm run husky:uninstall
128
128
```
129
129
130
-
## Gov IE DS package publishing
130
+
## Gov IE Frontend package publishing
131
131
132
132
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [squash commits](https://github.com/googleapis/release-please?tab=readme-ov-file#linear-git-commit-history-use-squash-merge) to `main`
133
133
- Versioning and npm package publishing is handled by the [Release Please GitHub action](https://github.com/google-github-actions/release-please-action)
Copy file name to clipboardExpand all lines: storybook/stories/get-started/get-started.mdx
+8-8
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,19 @@ import { Link } from '../components/Link.jsx';
5
5
6
6
# Get started
7
7
8
-
Get one Gov IE DS component working in your application, so you can test everything works before you add more components or styles.
8
+
Get one Gov IE Frontend component working in your application, so you can test everything works before you add more components or styles.
9
9
10
10
You will need to do all the following steps to get your component working.
11
11
12
-
1. Install Gov IE DS package.
12
+
1. Install Gov IE Frontend package.
13
13
2. Add the HTML for a component to your application.
14
14
3. Get the CSS working.
15
15
4. Get the font and images working.
16
16
5. Get the JavaScript working.
17
17
18
-
## 1. Install Gov IE DS package
18
+
## 1. Install Gov IE Frontend package
19
19
20
-
- You can <Linkhref="?path=/docs/docs-install-with-npm--docs">install Gov IE DS using npm</Link>.
20
+
- You can <Linkhref="?path=/docs/docs-install-with-npm--docs">install Gov IE Frontend using npm</Link>.
21
21
22
22
- If you've <Linkhref='?path=/story/docs-install-using-precompiled-files--docs'>installed using precompiled files</Link>, get started with a <Linkhref='?path=/story/docs-install-using-precompiled-files--docs#basic-example-page'>a basic page instead</Link>.
23
23
@@ -29,7 +29,7 @@ You will need to do all the following steps to get your component working.
29
29
30
30
## 3. Get the CSS working
31
31
32
-
1. Add the following to the main Sass file in your project, so your Sass compiler adds all of Gov IE DS styles to your CSS file.
32
+
1. Add the following to the main Sass file in your project, so your Sass compiler adds all of Gov IE Frontend styles to your CSS file.
33
33
34
34
```sass
35
35
@import '@ogcio/ogcio-ds/govie/all';
@@ -48,11 +48,11 @@ Run your application and check that the accordion displays correctly.
48
48
49
49
The accordion will use a generic font until you get the font and images working, and will not be interactive until you get the JavaScript working.
50
50
51
-
There are also different ways you can <Linkhref='?path=/docs/docs-import-css-assets-and-javascript--docs'>import Gov IE DS CSS</Link>.
51
+
There are also different ways you can <Linkhref='?path=/docs/docs-import-css-assets-and-javascript--docs'>import Gov IE Frontend CSS</Link>.
52
52
53
53
## 4. Get the font and images working
54
54
55
-
Your component will not use the right font or images until you've added Gov IE DS assets to your application.
55
+
Your component will not use the right font or images until you've added Gov IE Frontend assets to your application.
56
56
57
57
1. Copy the following 2 folders:
58
58
@@ -92,7 +92,7 @@ Run your application and check it works the same way as the Design System accord
92
92
93
93
In your live application:
94
94
95
-
- You must use `initAll` to initialise all components that use Gov IE DS JavaScript, or some components will not work correctly for disabled users who use assistive technologies
95
+
- You must use `initAll` to initialise all components that use Gov IE Frontend JavaScript, or some components will not work correctly for disabled users who use assistive technologies
96
96
97
97
We recommend <Linkhref='?path=/docs/docs-import-css-assets-and-javascript--docs#import-javascript'>using an automated task or your build pipeline</Link> instead of copying the files manually
You can install Gov IE DS by copying our CSS, JavaScript and asset files into your project. If you install this way, you can try Gov IE DS in your application without having to make many changes.
8
+
You can install Gov IE Frontend by copying our CSS, JavaScript and asset files into your project. If you install this way, you can try Gov IE Frontend in your application without having to make many changes.
9
9
10
10
> ! In your live application, you should install with Node.js package manager (npm) instead.
11
11
@@ -15,7 +15,7 @@ You'll not be able to:
15
15
16
16
- Change <Linkhref='?path=/story/docs-sass-api-reference--docs'>Sass settings</Link>, for example override colours or set your own font
17
17
-Importanindividualcomponent's CSS or JavaScript
18
-
- Use Gov IE DS colours or mixins in your custom code
18
+
- Use Gov IE Frontend colours or mixins in your custom code
2. Replace `<VERSION-NUMBER>` so the 3 filenames match the files you copied from Gov IE DS GitHub repo.
60
+
2. Replace `<VERSION-NUMBER>` so the 3 filenames match the files you copied from Gov IE Frontend GitHub repo.
61
61
3. Go to the <Linkhref='?path=/docs/typography-accordion--default'>example accordion component</Link> on the Design System website and copy the HTML from the first example.
62
62
4. Replace `<!-- component HTML -->` with the accordion HTML you copied.
63
63
5. Run your application - you can check it works the same way as the <Linkhref="iframe.html?id=typography-accordion--default&viewMode=story">Design System accordion example</Link> by selecting the buttons and checking the accordion 'shows' and 'hides' sections.
Copy file name to clipboardExpand all lines: storybook/stories/get-started/install-with-npm.mdx
+6-6
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ import { Link } from '../components/Link.jsx';
14
14
npm init
15
15
```
16
16
17
-
3. Install the Gov IE DS package
17
+
3. Install the Gov IE Frontend package
18
18
19
19
```
20
20
npm install @ogcio/ogcio-ds --save
@@ -26,11 +26,11 @@ You should now get started by <Link href='?path=/docs/docs-get-started--docs'>ge
26
26
27
27
## Update using Node.js package manager (npm)
28
28
29
-
You can update with Node.js package manager (npm) if you originally installed Gov IE DS with npm (mentioned above).
29
+
You can update with Node.js package manager (npm) if you originally installed Gov IE Frontend with npm (mentioned above).
30
30
31
31
### Find out which version you're using
32
32
33
-
To find out which version of Gov IE DS your project is using, you can run:
33
+
To find out which version of Gov IE Frontend your project is using, you can run:
34
34
35
35
```
36
36
npm list @ogcio/ogcio-ds
@@ -42,11 +42,11 @@ If you do not have command line access, you can see the version number in the `p
42
42
"@ogcio/ogcio-ds": "0.0.8"
43
43
```
44
44
45
-
## Update Gov IE DS using npm
45
+
## Update Gov IE Frontend using npm
46
46
47
-
To find out the latest version of Gov IE DS, check the [release notes](https://github.com/ogcio/ogcio-ds/releases) in the Gov IE DS GitHub repository.
47
+
To find out the latest version of Gov IE Frontend, check the [release notes](https://github.com/ogcio/ogcio-ds/releases) in the Gov IE Frontend GitHub repository.
48
48
49
-
You may need to make code changes to keep Gov IE DS working in your project, if the major version number changes when you update. The major version number is the first digit in the version number.
49
+
You may need to make code changes to keep Gov IE Frontend working in your project, if the major version number changes when you update. The major version number is the first digit in the version number.
0 commit comments