feat: optimize sequence timeline with showStepLabels option

[ooo1l]

What

Add showStepLabels option to sequence-timeline structure to allow hiding step labels (STEP 1, STEP 2, etc.).

Changes

• Add showStepLabels prop to SequenceTimelineProps interface (default: true)
• Make step label rendering conditional based on showStepLabels prop
• Update built-in templates (sequence-timeline-plain-text and sequence-timeline-simple) to hide step labels by default

Benefits

• Provides more flexibility for different design needs
• Some timeline designs don't need step labels
• Backwards compatible (defaults to true)

Test

• Tested locally
• No breaking changes (defaults to showing labels as before)

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the SequenceTimeline component by introducing a new configuration option that allows users to toggle the visibility of step labels. This provides increased flexibility for designers to customize timeline presentations, enabling cleaner layouts when step numbering is not required, while ensuring existing implementations remain unaffected due to the default behavior.

Highlights

• New showStepLabels Prop: Added a showStepLabels boolean prop to the SequenceTimelineProps interface, defaulting to true to maintain backward compatibility.
• Conditional Step Label Rendering: Implemented conditional rendering for the 'STEP X' labels within the SequenceTimeline component, based on the value of the new showStepLabels prop.
• Updated Built-in Templates: Modified the sequence-timeline-plain-text and sequence-timeline-simple built-in templates to set showStepLabels to false by default, optimizing their appearance.

Changelog

• src/designs/structures/sequence-timeline.tsx
  • Added showStepLabels property to the SequenceTimelineProps interface.
  • Destructured showStepLabels with a default value of true in the SequenceTimeline component.
  • Wrapped the step label rendering logic in a conditional block based on the showStepLabels prop.
• src/templates/built-in.ts
  • Configured the sequence-timeline-plain-text template to hide step labels by default.
  • Configured the sequence-timeline-simple template to hide step labels by default.

Activity

• No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request effectively introduces the showStepLabels option to the sequence-timeline component, providing greater flexibility for design needs. The implementation correctly adds the prop to the interface, sets a default value for backward compatibility, and conditionally renders the step labels based on this prop. Additionally, the built-in templates are updated as described to utilize this new option. The changes are well-contained and appear to function as intended.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.21%. Comparing base (d02d08f) to head (20bcba9).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #217   +/-   ##
=======================================
  Coverage   46.21%   46.21%           
=======================================
  Files         341      341           
  Lines       27964    27966    +2     
  Branches     2289     2289           
=======================================
+ Hits        12923    12925    +2     
  Misses      15029    15029           
  Partials       12       12           

Flag	Coverage Δ
infographic	46.21% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/designs/structures/sequence-timeline.tsx	100.00% <100.00%> (ø)
src/templates/built-in.ts	100.00% <100.00%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.