Skip to content
New issue

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

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

Already on GitHub? # to your account

Add Subtitle Prop to User Kit #2159

Merged
merged 5 commits into from
Oct 28, 2022
Merged

Add Subtitle Prop to User Kit #2159

merged 5 commits into from
Oct 28, 2022

Conversation

stephenmckeon
Copy link
Contributor

@stephenmckeon stephenmckeon commented Oct 26, 2022

Screens

Rails

Screen Shot 2022-10-26 at 4 14 14 PM

React

Screen Shot 2022-10-26 at 4 18 39 PM

Breaking Changes

No. The addition of the subtitle prop will leave all existing implementations unaffected.

Runway Ticket URL

https://nitro.powerhrg.com/runway/backlog_items/FINC-1625

How to test this

  • Regression test existing implementations of the User kit
  • For the rails kit, the subtitle prop accepts a string. When a string is passed, the text will appear as an additional row as body light font. The User kit now also accepts a block. Whatever is passed as a block will show below the user name and title/territory. The presence of a block will override the subtitle prop.
  • For the react kit, the subtitle prop accepts a string or component(s). When a string is passed, the text will appear as an additional row as body light font. When a component is passed, the component will render below the user name and title/territory.

Checklist:

  • LABELS Add a label: enhancement, bug, improvement, new kit, deprecated, or breaking. See Changelog & Labels for details.
  • DEPLOY Please add the Milano label when you are ready for a review.
  • SCREENSHOT Please add a screen shot or two.
  • SPECS Please cover your changes with specs.
  • READ DOCS Please make sure you have read and understand the Playbook Release Process

@stephenmckeon stephenmckeon added the enhancement New Features, Props, & Variants (USED IN CHANGELOG) label Oct 26, 2022
@stephenmckeon stephenmckeon self-assigned this Oct 26, 2022
Copy link
Contributor

@nidaqg nidaqg left a comment

Choose a reason for hiding this comment

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

Looks great! My only suggestion would be to add copy to the new doc examples, if only to differentiate between what subtitle does and what block_content_subtitle.

@stephenmckeon stephenmckeon marked this pull request as ready for review October 26, 2022 20:20
@stephenmckeon stephenmckeon requested a review from a team as a code owner October 26, 2022 20:20
@stephenmckeon stephenmckeon added the milano 20 MAX - Deploy this PR to a review environment via Milano label Oct 26, 2022
@jasperfurniss jasperfurniss merged commit c9a07c8 into master Oct 28, 2022
@jasperfurniss jasperfurniss deleted the add_caption_to_user branch October 28, 2022 17:51
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New Features, Props, & Variants (USED IN CHANGELOG) milano 20 MAX - Deploy this PR to a review environment via Milano
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants