Skip to content
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

Component: Event Log #1065

Merged
merged 7 commits into from
Dec 4, 2020
Merged

Component: Event Log #1065

merged 7 commits into from
Dec 4, 2020

Conversation

tylersticka
Copy link
Member

@tylersticka tylersticka commented Dec 3, 2020

Overview

Displays a list of event details in chronological order. Designed to show the presentation history for talks, workshops or other events we’ve conducted.

Improvements from the existing site's pattern (visible lower on this page):

  1. Each item has a heading element, which makes them easier to navigate with screen readers.
  2. Each date is a <time> element, which adds semantic meaning.
  3. Uses Subgrid in supported browsers browser (Microsoft is reported to be adding Chromium support, though, so 🤞)
  4. No need to manually add padding and border classes based on loop indexes in templates.
  5. Simpler markup, requiring four fewer elements and just over half as many characters as the live version.
  6. Works across themes.

This PR also renames the sizes.$list-inline-gap and sizes.$media-gap tokens to sizes.$gap-inline-medium and sizes.$gap-inline-small. The previous names were too specific to reflect the scope of their usage.

(Apologies if this is a rather anti-climactic PR after #1064: I started working on this PR while waiting for review on that one! I promise I'll be putting those mixins to use shortly. 😄)

Screenshots

Screen Shot 2020-12-03 at 3 38 10 PM

Screen Shot 2020-12-03 at 3 38 29 PM

Screen Shot 2020-12-03 at 3 38 42 PM

Testing

Check out the Event Log component deploy preview


/CC @AriannaChau

@tylersticka tylersticka requested review from a team December 3, 2020 23:53
@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2020

🦋 Changeset detected

Latest commit: 530d0ca

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@cloudfour/patterns Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@tylersticka tylersticka marked this pull request as ready for review December 4, 2020 00:00
Copy link
Member

@Paul-Hebert Paul-Hebert left a comment

Choose a reason for hiding this comment

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

Looks good to me!

*/

.c-event-log__item {
display: grid;
Copy link
Member

Choose a reason for hiding this comment

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

Do we need any fallback for non-grid browsers? Or are we fine with default styles at that point?

Copy link
Member

@Paul-Hebert Paul-Hebert Dec 4, 2020

Choose a reason for hiding this comment

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

I was unable to actually test this in a browser without Grid since storybook fails to load in IE11, however I tried disabling the grid rule and it looked fine, so I think we should be fine here:

Screen Shot 2020-12-03 at 4 34 41 PM


Displays a list of event details in chronological order. Designed to show the presentation history for talks, workshops or other events we’ve conducted.

For a less specialized display of tabular data, consider using [Table](/?path=/docs/components-table--basic). For simple string/number pairs, consider [Dot Leader](/?path=/docs/components-dot-leader--list). To display a single or upcoming date, consider using [Calendar Date](/?path=/docs/components-calendar-date--basic) (optionally combined with [Media](/?path=/docs/objects-media--event-summary)).
Copy link
Member

Choose a reason for hiding this comment

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

This is great! 👍

I'd like to see more of this "when not to use this component" type documentation in component libraries

@tylersticka tylersticka merged commit 90fae26 into v-next Dec 4, 2020
@tylersticka tylersticka deleted the feature/c-event-log branch December 4, 2020 00:58
@github-actions github-actions bot mentioned this pull request Dec 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants