Skip to content

Commit 8f57fcf

Browse files
chore(static-site): update terminology and guides
1 parent 5f1ac50 commit 8f57fcf

File tree

5 files changed

+27
-28
lines changed

5 files changed

+27
-28
lines changed
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# ASU Header
1+
# ASU Header and Footer
22
ASU Web Standards-based implementation of global header and footer.
33

44
## CLI Commands
55

66
``` bash
7-
# add component-footer
7+
# add component-header-footer
88
yarn add @asu/component-header-footer
99
# or if you use npm
1010
npm install @asu/component-header-footer
@@ -13,21 +13,21 @@ npm install @asu/component-header-footer
1313

1414
## How to install
1515

16-
1. Either make sure you are part of the ASU github organization and follow the instructions [here,](https://github.com/ASU/asu-unity-stack#-how-to-use-the-private-package-registry)or, if you already are, you can clone this repo and run `yarn install` and `yarn build` to build the package locally.
16+
1. Either make sure you are part of the ASU github organization and follow the instructions [here](https://github.com/ASU/asu-unity-stack#-how-to-use-the-private-package-registry) or if you already are, you can clone this repo and run `yarn install` and `yarn build` to build the package locally.
1717
<br/>
18-
1. ```yarn add @asu/component-header```
18+
1. ```yarn add @asu/component-header-footer```
1919

2020
## Use as a JS module in React app
2121

2222
### Default import
2323
```JAVASCRIPT
24-
import { ASUHeader, ASUFooter } from '@asu/component-header-footer'
24+
import { ASUHeader, ASUFooter } from '@asu/component-header-footer'
2525
```
2626

2727
### Aliased import
2828
```JAVASCRIPT
29-
import { ASUHeader as Header, ASUFooter as Footer } from '@asu/component-header-footer'
29+
import { ASUHeader as Header, ASUFooter as Footer } from '@asu/component-header-footer'
3030
```
3131

3232
### Import for use in HTML page
33-
You can find an example of how to set `ASUHeader` props for use in a browser [here](/packages/component-header/examples/global-header.html)
33+
You can find an example of how to set `ASUHeader` and `ASUFooter` props for use in a browser [here](/packages/component-header/examples/global-header-footer.html)

packages/static-site/src/components/Card.tsx

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,31 @@ export interface CardWrapperProps {
66
description: string | JSX.Element;
77
href: string;
88
linkLabel: string;
9+
ariaLabel?: string;
910
isRoute?: boolean;
1011
}
1112
const CardWrapper: FC<CardWrapperProps> = ({
1213
title,
1314
description,
1415
href,
1516
linkLabel,
17+
ariaLabel,
1618
isRoute,
1719
}) => {
1820
return (
1921
<div className="col-lg-4 col-md-6 pb-8">
2022
<h3>{title}</h3>
2123
<p>{description}</p>
2224
<p>
23-
{isRoute ? (
24-
<a className="btn btn-maroon btn-medium" href={getRelativePath(href)}>
25-
{linkLabel}
26-
</a>
27-
) : (
28-
<a
29-
className="btn btn-maroon btn-medium"
30-
target="_blank"
31-
rel="noreferrer"
32-
href={href}
33-
>
34-
{linkLabel}
35-
</a>
36-
)}
25+
<a
26+
className="btn btn-maroon btn-medium"
27+
href={isRoute ? getRelativePath(href) : href}
28+
target={isRoute ? undefined : "_blank"}
29+
rel={isRoute ? undefined : "noreferrer"}
30+
aria-label={ariaLabel}
31+
>
32+
{linkLabel}
33+
</a>
3734
</p>
3835
</div>
3936
);

packages/static-site/src/pages/HeaderGuide.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const HeaderGuide = () => {
77
<div className="container my-6">
88
<div className="row">
99
<div className="col-12">
10-
<h1 className="display-4">ASU Header Guide</h1>
10+
<h1 className="display-4">ASU Header and Footer Guide</h1>
1111

1212
<p>
1313
Testing data shows that users see asu.edu as one website. The ASU

packages/static-site/src/pages/Home.tsx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ const Home = () => {
3535
across all ASU web projects. Seamlessly explore the Design Kit and Code Kit
3636
in one place."
3737
href="https://zeroheight.com/9f0b32a56"
38-
linkLabel="UDS Guidelines"
38+
linkLabel="View UDS guidelines"
3939
/>
4040
<Card
4141
title="Design Kit"
4242
description="Design specifications for components provided by the ASU Brand."
4343
href="https://www.figma.com/design/vhudREMl5qdTxRLZTmttHJ/UDS-Design-Kit--web-only-?node-id=593-23577&p=f&t=ZiUlJTLE1HyXrZrB-0"
44-
linkLabel="UDS Design Kit"
44+
linkLabel="View UDS design Kit"
4545
/>
4646
<Card
4747
title="Code Kit"
4848
description="Npm packages provide React components and Bootstrap HTML examples for implementing UDS components."
4949
href="./index.html#codekit"
50-
linkLabel="Code Kit section below"
50+
linkLabel="View code kit section below"
5151
isRoute={true}
5252
/>
5353
</div>
@@ -57,19 +57,21 @@ const Home = () => {
5757
<Divider />
5858
<div className="row my-6">
5959
<Card
60-
title="ASU Header"
60+
title="ASU Header and Footer"
6161
description="Guidelines, requirements and best practices for using the ASU
6262
Branded Header in your site."
6363
href={PagePaths.HEADERGUIDE + "index.html"}
6464
isRoute={true}
65-
linkLabel="ASU Header Guide"
65+
linkLabel="View guide"
66+
ariaLabel="View ASU header and footer guide"
6667
/>
6768
<Card
6869
title="Google Tag Manager and data layer"
6970
description="Ensure your site or application has the necessary analytics integrations."
7071
href={PagePaths.DATALAYERGUIDE + "index.html"}
7172
isRoute={true}
72-
linkLabel="GTM and Data Layer Guide"
73+
linkLabel="View guide"
74+
ariaLabel="View Google Tag Manager and data layer guide"
7375
/>
7476
<Card
7577
title="Unity Design System Package Registry"

0 commit comments

Comments
 (0)