Skip to content

Commit e6841a5

Browse files
Merge pull request #1579 from ASU/UDS-1947
chore: update terminology
2 parents bae585c + 8f57fcf commit e6841a5

File tree

7 files changed

+69
-60
lines changed

7 files changed

+69
-60
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@
2020

2121
- [JIRA ticket](https://asudev.jira.com/browse/UDS-0000)
2222
- [Unity reference site](https://asu.github.io/asu-unity-stack/)
23-
- [Unity Design Kit](https://shared-assets.adobe.com/link/fb14b288-bf63-47e0-5d30-384de5560455)
23+
- [UDS Guidelines](https://zeroheight.com/9f0b32a56/p/96ab23-getting-started)
2424

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: 12 additions & 15 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 (
19-
<div className="col-md-6 pb-8">
21+
<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/components/PackageCards.tsx

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,27 @@ const packages: Record<string, { default: PackageJson }> = import.meta.glob(
1313
);
1414

1515
export const DeprecatedPackageCards = () => {
16-
const cards: CardWrapperProps[] = [];
17-
18-
for (const key in packages) {
19-
const p = packages[key].default;
20-
const deprecated = p.deprecated ? p.deprecated : false;
21-
if (
22-
p.private !== true &&
23-
deprecated !== false &&
24-
typeof deprecated === "string"
25-
) {
26-
cards.push({
27-
title: p.name,
28-
description: deprecated,
29-
href: `/${p.name}/index.html`,
30-
linkLabel: "Launch",
31-
isRoute: true,
32-
});
33-
}
34-
}
35-
16+
// Manually add deprecated packages, as they may no longer be in the packages folder
3617
return (
3718
<>
38-
{cards.map((card, index) => (
39-
<CardWrapper key={index} {...card} />
40-
))}
19+
<CardWrapper
20+
title="@asu/components-core"
21+
description="Core UDS React UI components required by other higher-order React packages"
22+
href="https://github.com/orgs/ASU/packages/npm/package/components-core"
23+
linkLabel="View npm package"
24+
/>
25+
<CardWrapper
26+
title="@asu/component-header"
27+
description="ASU Global Header"
28+
href="https://github.com/orgs/ASU/packages/npm/package/component-header"
29+
linkLabel="View npm package"
30+
/>
31+
<CardWrapper
32+
title="@asu/component-footer"
33+
description="ASU Global Footer"
34+
href="https://github.com/orgs/ASU/packages/npm/package/component-footer"
35+
linkLabel="View npm package"
36+
/>
4137
</>
4238
);
4339
};

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: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const Home = () => {
1717
<div className="row my-6">
1818
<div className="col-md-8">
1919
<p className="lead">
20-
A design system enables your product teams to share learnings
20+
Unity Design System enables your product teams to share learnings
2121
across silos, avoid duplicate work and focus more on user
2222
experience problems rather than UI problems, complete with
2323
guidelines, principles, philosophies and code.
@@ -26,37 +26,52 @@ const Home = () => {
2626
</div>
2727
</div>
2828
<div className="container">
29-
<h2>Resources</h2>
29+
<h2>Unity Design System (UDS)</h2>
3030
<Divider />
3131
<div className="row my-6">
3232
<Card
33-
title="Unity Design System UI Kit"
33+
title="UDS Guidelines"
3434
description="Guidelines, standards, and best-practices for Unity Design System
35-
across all ASU web projects."
35+
across all ASU web projects. Seamlessly explore the Design Kit and Code Kit
36+
in one place."
3637
href="https://zeroheight.com/9f0b32a56"
37-
linkLabel="Explore the UDS UI Kit"
38+
linkLabel="View UDS guidelines"
3839
/>
39-
4040
<Card
41-
title="Unity Design System Styles Library"
42-
description="A community-built design system built with Adobe XD."
43-
href="https://shared-assets.adobe.com/link/fb14b288-bf63-47e0-5d30-384de5560455"
44-
linkLabel="View the document"
41+
title="Design Kit"
42+
description="Design specifications for components provided by the ASU Brand."
43+
href="https://www.figma.com/design/vhudREMl5qdTxRLZTmttHJ/UDS-Design-Kit--web-only-?node-id=593-23577&p=f&t=ZiUlJTLE1HyXrZrB-0"
44+
linkLabel="View UDS design Kit"
4545
/>
4646
<Card
47-
title="ASU Header"
47+
title="Code Kit"
48+
description="Npm packages provide React components and Bootstrap HTML examples for implementing UDS components."
49+
href="./index.html#codekit"
50+
linkLabel="View code kit section below"
51+
isRoute={true}
52+
/>
53+
</div>
54+
</div>
55+
<div className="container">
56+
<h2>Implementing UDS</h2>
57+
<Divider />
58+
<div className="row my-6">
59+
<Card
60+
title="ASU Header and Footer"
4861
description="Guidelines, requirements and best practices for using the ASU
4962
Branded Header in your site."
5063
href={PagePaths.HEADERGUIDE + "index.html"}
5164
isRoute={true}
52-
linkLabel="View the guide"
65+
linkLabel="View guide"
66+
ariaLabel="View ASU header and footer guide"
5367
/>
5468
<Card
5569
title="Google Tag Manager and data layer"
5670
description="Ensure your site or application has the necessary analytics integrations."
5771
href={PagePaths.DATALAYERGUIDE + "index.html"}
5872
isRoute={true}
59-
linkLabel="GTM and data layer guide"
73+
linkLabel="View guide"
74+
ariaLabel="View Google Tag Manager and data layer guide"
6075
/>
6176
<Card
6277
title="Unity Design System Package Registry"
@@ -87,6 +102,7 @@ const Home = () => {
87102
/>
88103
</div>
89104
</div>
105+
<a id="codekit"></a>
90106
<div className="container">
91107
<h2>Npm Packages</h2>
92108
<Divider />

0 commit comments

Comments
 (0)