Skip to content

docs(component-header-footer): update readme and example #1532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2025
Merged

docs(component-header-footer): update readme and example #1532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5ce5d7
docs(component-header-footer): update readme and example
davidornelas11 May 8, 2025
243178c
docs(static-site): update header docs
davidornelas11 May 8, 2025
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
22 changes: 7 additions & 15 deletions packages/component-header-footer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
# ASU Header
ASU Web Standards-based implementation of global header.
ASU Web Standards-based implementation of global header and footer.

## CLI Commands

``` bash
# add component-footer
yarn add @asu/component-header


# run storybook
yarn storybook

# build for production with minification
yarn build

# run tests
yarn test
yarn add @asu/component-header-footer
# or if you use npm
npm install @asu/component-header-footer

```

Expand All @@ -29,13 +21,13 @@ yarn test

### Default import
```JAVASCRIPT
import { ASUHeader } from '@asu/component-header@dev'
import { ASUHeader, ASUFooter } from '@asu/component-header-footer'
```

### Aliased import
```JAVASCRIPT
import { ASUHeader as Header } from '@asu/component-header@dev'
import { ASUHeader as Header, ASUFooter as Footer } from '@asu/component-header-footer'
```

### Import for use in HTML page
You can find an example of how to set `ASUHeader` props [here](/packages/component-header/examples/global-header.html)
You can find an example of how to set `ASUHeader` props for use in a browser [here](/packages/component-header/examples/global-header.html)
299 changes: 176 additions & 123 deletions packages/component-header-footer/examples/global-header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
<script src="https://unpkg.com/react-dom@18.3.1/umd/react-dom.development.js" crossorigin></script>
<!-- *************************************************************** -->
<!-- include bundled scripts from packages -->
<script src="../dist/vendor.umd.js"></script>
<script src="../dist/asuHeader.umd.js"></script>
<script src="../dist/asuHeaderFooter.umd.js"></script>
</head>

<body>
Expand All @@ -23,130 +22,131 @@ <h1 style='text-align: center ; font-family: Arial'>
Scroll section
</h1>
</div>
<div id="footer-container"></div>

<script>
const navTree =[
{
href: "/",
text: "Home",
type: "icon-home",
selected: true,
class: "test-class",
},
{
text: "Degree programs",
href: "#",
items: [
[
{
href: "https://www.asu.edu/?feature=newsevents",
text: "Mauris viverra, sem nec",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Academics",
},
{
href: "https://www.asu.edu/?feature=research",
text: "Research",
},
{
href: "https://www.asu.edu/?feature=athletics",
text: "Athletics",
},
{
href: "https://www.asu.edu/?feature=alumni",
text: "Alumni",
},
{
href: "https://www.asu.edu/?feature=giving",
text: "Giving",
},
{
href: "https://www.asu.edu/?feature=president",
text: "President",
},
{
href: "https://www.asu.edu/about",
text: "About ASU",
},
],
const navTree = [
{
href: "/",
text: "Home",
type: "icon-home",
selected: true,
class: "test-class",
},
{
text: "Degree programs",
href: "#",
items: [
[
{
href: "https://www.asu.edu/?feature=newsevents",
text: "Mauris viverra, sem nec",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Academics",
},
{
href: "https://www.asu.edu/?feature=research",
text: "Research",
},
{
href: "https://www.asu.edu/?feature=athletics",
text: "Athletics",
},
{
href: "https://www.asu.edu/?feature=alumni",
text: "Alumni",
},
{
href: "https://www.asu.edu/?feature=giving",
text: "Giving",
},
{
href: "https://www.asu.edu/?feature=president",
text: "President",
},
{
href: "https://www.asu.edu/about",
text: "About ASU",
},
],
},
],
},

{
text: "People",
href: "#",
},
{
text: "My ASU",
href: "#",
},
{
text: "Two Column 1",
href: "/",
items: [
[
{
type: "heading",
text: "Column 1",
},
{
href: "https://www.asu.edu/",
text: "Pellentesque ornare",
},
{
href: "https://www.asu.edu/",
text: "Curabitur viverra arcu nisl",
},
{
href: "https://www.asu.edu/?feature=athletics",
text: "Aenean pharetra",
},
{
href: "https://www.asu.edu/?feature=alumni",
text: "Pellentesque",
},
{
href: "https://www.asu.edu/?feature=giving",
text: "Donec sagittis nulla",
},
{
href: "https://www.asu.edu/?feature=president",
text: "Quisque fringilla",
},
{
href: "https://www.asu.edu/about",
text: "Integer vel gravida lectus",
},
],
[
{
href: "https://www.asu.edu/?feature=newsevents",
type: "heading",
text: "Ut quis",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Nunc in libero odio",
},
{
href: "https://www.asu.edu/?feature=research",
text: "Maecenas quam elit",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Ut at vehicula neque",
},
{
href: "https://www.asu.edu/?feature=athletics",
type: "button",
text: "Sed molestie",
},
],
{
text: "People",
href: "#",
},
{
text: "My ASU",
href: "#",
},
{
text: "Two Column 1",
href: "/",
items: [
[
{
type: "heading",
text: "Column 1",
},
{
href: "https://www.asu.edu/",
text: "Pellentesque ornare",
},
{
href: "https://www.asu.edu/",
text: "Curabitur viverra arcu nisl",
},
{
href: "https://www.asu.edu/?feature=athletics",
text: "Aenean pharetra",
},
{
href: "https://www.asu.edu/?feature=alumni",
text: "Pellentesque",
},
{
href: "https://www.asu.edu/?feature=giving",
text: "Donec sagittis nulla",
},
{
href: "https://www.asu.edu/?feature=president",
text: "Quisque fringilla",
},
{
href: "https://www.asu.edu/about",
text: "Integer vel gravida lectus",
},
],
},
{
[
{
href: "https://www.asu.edu/?feature=newsevents",
type: "heading",
text: "Ut quis",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Nunc in libero odio",
},
{
href: "https://www.asu.edu/?feature=research",
text: "Maecenas quam elit",
},
{
href: "https://www.asu.edu/?feature=academics",
text: "Ut at vehicula neque",
},
{
href: "https://www.asu.edu/?feature=athletics",
type: "button",
text: "Sed molestie",
},
],
],
},
{
text: "Mega Menu (5 Col)",
href: "#",
buttons: [
Expand Down Expand Up @@ -310,7 +310,7 @@ <h1 style='text-align: center ; font-family: Arial'>
],
},
];
AsuHeader.initGlobalHeader({
AsuHeaderFooter.initGlobalHeader({
targetSelector: "#header-container",
Copy link
Contributor

@scott-williams-az scott-williams-az May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is minor and probably out of scope, but the names of the init functions could be simplified
AsuHeaderFooter.initHeader, AsuHeaderFooter.initFooter.

props: {
loggedIn: false,
Expand Down Expand Up @@ -338,7 +338,60 @@ <h1 style='text-align: center ; font-family: Arial'>
site: "subdomain",
},
});
AsuHeaderFooter.initASUFooter({
targetSelector: "#footer-container",
props: {
social: {
logoUrl: "https://asu.github.io/asu-unity-stack/@asu/component-header-footer/assets/endorsedLogo-DPPmUtP1.png",
unitLogo: "https://asu.github.io/asu-unity-stack/@asu/component-header-footer/assets/endorsedLogo-DPPmUtP1.png",
mediaLinks: {
facebook: "https://facebook.com",
twitter: "https://twitter.com/?lang=en",
instagram: "https://instagram.com",
linkedIn: "https://www.linkedin.com/",
youtube: "https://www.youtube.com/",
},
},
contact: {
title: "Complete Name of College, School or Unit Title Should Go Here",
contactLink: "#",
contributionLink: "#",
columns: [
{
title: "Column One",
links: [
{
url: "#",
title: "link",
text: "Biological and Health Systems Computing",
},
{
url: "#",
title: "link",
text: "Informatics and Decision Systems Electrical",
},
{
url: "#",
title: "link",
text: "Computer and Energy Matter",
},
{
url: "#",
title: "link",
text: "Transport and Energy Sustainability and the Built Environment",
},
{
url: "#",
title: "link",
text: "The Polytechnic School",
},
],
},
],
}
},
});
</script>
</body>
</body>

</html>
Loading