Skip to content

Update component.md #46

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.

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 1 commit into from
May 7, 2021
Merged
Changes from all commits
Commits
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
288 changes: 200 additions & 88 deletions COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,112 +4,224 @@ TODO List of needed components for this website.

## Global

- [x] ResponsiveImage
- [x] ResponsiveImage

- [x] ButtonMore
- text
- [x] ButtonMore

- [x] SiteBrandBar
- (Contains SVG of logo that links)
- text

- [x] NavSecondary
- items: [{text, url, target}]
- [x] SiteBrandBar

- [x] NavPrimary
- items: [{name = "", url = "", items = [{text, url, target}]], {}}
- (Contains SVG of logo that links)

- [x] SmartLink
- to
- target
- default slot: <smart-link>something </smart-link>
- [x] NavSecondary

- [x] MastheadPrimary
- (Contains SearchHome)
- items: [{text, url, target}]

- [x] MastheadSecondary
- hasMolecules: boolean
- title
- text
- (slot: used for search form)
- [x] NavPrimary

- [x] DividerWayfinder
- color: "help"
- bold: boolean
- items: [{name = "", url = "", items = [{text, url, target}]], {}}

- [x] DividerVertical
- [x] SmartLink

- [x] FooterPrimary
- social-items: [{text, url}]
- press-items: [{text, url}]
- (Uses form-mailing-list?)
- to
- target
- default slot: <smart-link>something </smart-link>

- [x] FooterSock
- items: [{text, url, target}]
- [x] MastheadPrimary

- [x] SiteNotificationAlert
- title
- text
- (Contains SearchHome)

- [x] MastheadSecondary

- hasMolecules: boolean
- title
- text
- (slot: used for search form)

- [x] DividerWayfinder

- color: "help"
- bold: boolean

- [x] DividerVertical

- [x] FooterPrimary

- social-items: [{text, url}]
- press-items: [{text, url}]
- (Uses form-mailing-list?)

- [x] FooterSock

- items: [{text, url, target}]

- [x] SiteNotificationAlert
- title
- text

## Home

- [x] SectionCards
- title
- text
- items: [{see card props}] (uses CardVertical component)
- to: ""

- [x] BlockCardVertical
- iconName: String
- title
- text
- to
- section: "" // get-help, visit, about

- [x] BlockCardMore
- text
- to

- [x] BannerFeatured
- image
- title
- category: {name, to}
- theme
- dates: String
- times: String
- location: String
- isOnline: boolean
- to
- breadcrumb: {text, to}
- prompt: String
- (slot that replaces top breadcrumb)
- alignment: "left" or "right"

- [x] SectionDualMasonry
- items: [{image, category, title, prompt, dates, to}]
- to

- [x] HeadingArrow
- text
- to

- [x] SectionPostSmall
- items: [{see BlockPostSmall}]
- to

- [x] BlockPostSmall
- image
- category: {name, to}
- title
- author
- to
- theme
- [x] SectionCards

- title
- text
- items: [{see card props}] (uses CardVertical component)
- to: ""

- [x] BlockCardVertical

- iconName: String
- title
- text
- to
- section: "" // get-help, visit, about

- [x] BlockCardMore

- text
- to

- [x] BannerFeatured

- image
- title
- category: {name, to}
- theme
- dates: String
- times: String
- location: String
- isOnline: boolean
- to
- breadcrumb: {text, to}
- prompt: String
- (slot that replaces top breadcrumb)
- alignment: "left" or "right"

- [x] SectionDualMasonry

- items: [{image, category, title, prompt, dates, to}]
- to

- [x] HeadingArrow

- text
- to

- [x] SectionPostSmall

- items: [{see BlockPostSmall}]
- to

- [x] BlockPostSmall
- image
- category: {name, to}
- title
- author
- to
- theme

## Search

- [ ] SearchHome
- TODO what props?
- [ ] SearchHome

- tabs: [{title, isActive}]
- links: [{name, url, target}](Course Reserves etc)
- actionUrl: String
// search by keyword
exampleString: "https://ucla.on.worldcat.org/external-search"
exampleString: "https://ucla.summon.serialssolutions.com/#!/search?ho=t&l=en&"
exampleString: "fromPrimo"
(build component out knowing where to submit the query string)

- [ ] SearchGeneric
- actionUrl:"",
- filters: [{name, queryParam},{},...]

example:

```json
actionUrl:"", //main search block
filters: [ // dependent on the page ?
{
name: "location",
filterItems: [
{
name: "Arts Library",
queryParam: "artsLib"
},
{
name: "Bio Med",
queryParam: "bioMed"
},
]
},
{
name: "department",
filterItems: [
{
name: "Science Department",
queryParam: "scienceDept"
},
{
name: "Music Department",
queryParam: "musicDept"
},
]
},
]
```

- note: (each page will have its own list of filters available - from craft - content-types)

## Mobile Versions

Mobile nav/menus combine the Primary and Secondary navs
hard code menu items using data()

- [ ] MobileNav

```
data() {
primary: [{text, url, target}] ,
secondary: [{text, url, target}] ,
}
```

## Exhibits & Upcoming Events

- [ ] BlockTeaser

- items: {image: {}, to, category, title, dates, times, text}
- displayImage: Boolean // default: true - only false on calendar page

note: displayImage --may be able to just filter this out

- [ ] SectionTeaserHighlight

- items: [{see block props}] (uses BlockVisitVertical component)

- [ ] SectionTeaserList

- items: [{see block props}] (uses BlockVisitHorizontal component)

- [ ] SectionTeaserGallery

- items: [{see block props}] (uses BlockVisitHorizontal component)

- [ ] BlockCallToAction
- iconName: String
- title
- text
- name //button
- to

note: 2 sizes full width & half page

## Article Detail Page

according to the data model, Articles will be used in "A blog post or other timely story from the UCLA library"

## TODO
context: this is the only part of the data model in our CraftCMS that is close to being done (pending) approval

- TODO Mobile nav/menus Primary and Secondary?
so, we can look at those designs and focus on making component request issues for the relevant components