Simplify option API with mark/overlay props #110
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…iguration - Updated the MarkedInput component to use a more intuitive overlay configuration, replacing `slotProps` with direct `overlay` properties. - Simplified the Option interface by removing `slotProps` and directly integrating `mark` and `overlay` properties for better clarity and usability. - Enhanced documentation to reflect these changes, ensuring accurate API references and examples. - Adjusted related components and stories to align with the new structure, improving overall consistency across the codebase.
- Updated the Option interface to support generic type parameters for mark and overlay props, improving flexibility and type safety. - Modified the MarkedInput component to utilize the updated Option interface, ensuring consistent typing across options. - Adjusted documentation to reflect changes in type definitions and examples, enhancing clarity for users. - Updated references in related markdown files to point to the correct line numbers following the interface modifications.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Updated the MarkedInput stories in Base and Overlay to use generic type parameters for improved type safety and clarity. - Removed unnecessary slotProps in the index.tsx file, streamlining the configuration of mark and overlay properties. - Ensured consistency across the codebase by aligning story definitions with the latest interface changes.
- Improved formatting of the ConfiguredMarkedInput interface for better readability. - Simplified the useTrigger function by condensing the overlayMatch assignment into a single line. - Enhanced the useSlot function signature for clarity by removing unnecessary line breaks. - These changes aim to improve code maintainability and readability across the markput package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
slots/slotPropswithmarkandoverlayprops that carry both component (slot) and props, keeping defaults via globalMark/Overlayor provided base props.overlay, aligning with the new shape and improving type inference for MarkedInput and createMarkedInput.useSlotresolution to readmark/overlayprops (including inline slot) and updated StoreProvider typing.Breaking Change
slotsorslotProps; per-option customization must now usemarkandoverlayobjects (each may includeslotfor the component). Overlay trigger/data and mark props must move to these new fields.Migration Guide
slots.mark→mark.slot;slots.overlay→overlay.slot.slotProps.mark→mark;slotProps.overlay(includingtrigger,data, etc.) →overlay.MarkandOverlaystill act as defaults whenmark.slot/overlay.slotare absent.slotProps.mark: (p) => ...withmark: (p) => ....