The three statuses above and their possible values:

For more information see the https://openedx.atlassian.net/wiki/spaces/BPL/pages/1773502564/Component+Contribution+Process#Step-1-%E2%80%93-Start-a-component-proposal.

A brief one or two sentence description of this component, its purpose, and common use cases.

Contributors

Gabriel Weinberg

Slack channel

If one exists, paste a link to the working Slack channel...

Paragon Jira ticket

Insert a link to the Paragon ticket or epic for this component...

Other Jira tickets

Insert links to related work...

Design resources

Insert links to Figma or Miro design specs or explorations...

Technical docs

Insert a link to the tech docs when they are created...


Design

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-Design-System?type=design&node-id=57636%3A3830&mode=design&t=R1iASPrwv3VXuBcy-1

Image backup:

(blue star) Variants

Overlay/Inline
Component can be an overlay, similar to modal or toast component, or it can be used inline within the body of the page

Embedded feedback/link-to feedback
Feedback interactions can be directly inside the widget or a button can link to offsite feedback

Dismissible
Component can be optionally dismissed (Inline-only)


(blue star) Best Practices

Do

Don't

(blue star) Related Components

https://paragon-openedx.netlify.app/components/card/

https://paragon-openedx.netlify.app/foundations/typography/

https://paragon-openedx.netlify.app/components/iconbutton/

https://paragon-openedx.netlify.app/components/form/form-control/


(blue star) Specification

What does an engineer need to know in order to build this component?

Redlined Design Spec

Paste a link to a Figma frame here and choose "Display as embed"...

(blue star) Behaviors

Add rows to this table outlining individual behaviors of the component.

Stateful interactions
When the user interacts with the component, it shows a secondary, customizable screen

(blue star) Accessibility

Add rows to the table outlining focus management, semantic markup, or other a11y related specifications...

Overlay version takes focus


Notes

Notes from collaborator conversations or meetings regarding this component.

XX.XX.20XX