Skip to content

feat: optimize sequence timeline with showStepLabels option#217

Open
ooo1l wants to merge 1 commit intoantvis:mainfrom
ooo1l:feat/optimize-sequence-timeline
Open

feat: optimize sequence timeline with showStepLabels option#217
ooo1l wants to merge 1 commit intoantvis:mainfrom
ooo1l:feat/optimize-sequence-timeline

Conversation

@ooo1l
Copy link

@ooo1l ooo1l commented Feb 27, 2026

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
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

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.

1 participant