Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourYellow
titleDRAFT
Status
colourPurple
titleDesign IN PROGRESS
Status
titleIMPLEMENTATION PENDING

Expand
titleWhat are these tags?

The three statuses above and their possible values:

Status
titlePROPOSAL STATUS

Status
titleDESIGN STATUS

Status
titleIMPLEMENTATION STATUS

Status
colourYellow
titleDRAFT

Status
titleDESIGN PENDING

Status
titleIMPLEMENTATION PENDING

Status
colourBlue
titleREADY FOR REVIEW

Status
colourYellow
titleDESIGN PLANNED

Status
colourYellow
titleIMPLEMENTATION PLANNED

Status
colourGreen
titleAPPROVED TO ADD

Status
colourPurple
titleDESIGN IN PROGRESS

Status
colourPurple
titleIMPLEMENTATION IN PROGRESS

Status
colourRed
titleDEFERRED

Status
colourGreen
titleDESIGN COMPLETE

Status
colourGreen
titleIMPLEMENTATION COMPLETE

Status
colourPurple
titleNEEDS CHANGES

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.

Contributors

Gabriel Weinberg

Slack channel

Paragon Jira ticket

Other Jira tickets

Design resources

Technical docs


Table of Contents
maxLevel2
typeflat
separatorpipe

Design

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

🌳 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)


🌞 Best Practices

Tip

Do

Warning

Don't

♊ 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/


📐 Specification

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

Redlined Design Spec

♒ Behaviors

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

💕 Accessibility

Overlay version takes focus


Notes

Notes from collaborator conversations or meetings regarding this component.

XX.XX.20XX