Skip to content

Conversation

@galangel
Copy link
Owner

@galangel galangel commented Jan 14, 2026

This pull request introduces a new minor version (1.1.0) of React Tip Magic, focusing on improved keyboard shortcut discoverability, documentation clarity, and sponsorship options. The most significant changes include a refactor of the keyboard shortcut API to use a dedicated data-tip-shortcut attribute, comprehensive updates to documentation and usage examples, and the addition of fuzzy search support for shortcut discovery. There are also updates to Storybook story ordering and the introduction of a funding configuration file.

Keyboard shortcut API and discoverability improvements:

  • Refactored keyboard shortcut display to use the data-tip-shortcut attribute instead of parsing tooltip text, making shortcut badges more explicit and easier to manage. All documentation and usage examples have been updated to reflect this change. [1] [2] [3] [4] [5] [6]
  • Added the fuzzysort dependency to enable fuzzy search for keyboard shortcuts in the TipAdvisor component, enhancing shortcut discoverability.

Documentation and onboarding improvements:

  • Major rewrite and restructuring of README.md to provide clearer onboarding, feature explanations, and usage patterns, with new sections for tooltips, guided tours, TipAdvisor, and programmatic API. [1] [2]
  • Updated version to 1.1.0 in package.json to reflect these breaking and additive changes.

Storybook and project configuration:

  • Changed Storybook story ordering to prioritize new components (The Tooltip, The Tourtip, The TipAdvisor) for improved documentation navigation.
  • Added .github/FUNDING.yml to enable project sponsorship through multiple platforms.

Signed-off-by: galangel <gal0angel@gmail.com>
Signed-off-by: galangel <gal0angel@gmail.com>
@galangel galangel merged commit 3421d35 into main Jan 14, 2026
6 checks passed
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.

2 participants