-
Notifications
You must be signed in to change notification settings - Fork 10
refactor!: significant refactor of message and modal components #310
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
DCodeProg
wants to merge
39
commits into
mineral-dart:main
Choose a base branch
from
DCodeProg:refactor/307-message-and-modal-component-interfaces
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
refactor!: significant refactor of message and modal components #310
DCodeProg
wants to merge
39
commits into
mineral-dart:main
from
DCodeProg:refactor/307-message-and-modal-component-interfaces
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
…entation - Change addGallery to accept List<MediaItem> directly - Update addSection to use named parameters like addContainer - Add detailed documentation for all public methods - Include practical examples for each method
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.
Description
This PR introduces a major architectural refactoring of the component system, transitioning from prefixed component classes (e.g.,
MessageButton,ModalTextInput) to unified component classes that implement specific interfaces (MessageComponent,ModalComponent). This aligns with Discord's component specification v2 and significantly improves the developer experience.🎯 Key Changes
1. Component Interface Architecture
Introduced a new interface-based system:
Component- Base interface for all componentsMessageComponent- Interface for components usable in messagesModalComponent- Interface for components usable in modalsBefore:
After:
2. Component Renaming
All components renamed to remove context prefixes:
MessageButton→ButtonMessageRowBuilder→ActionRowMessageFile→AttachedFileMessageThumbnail→ThumbnailMessageGallery→MediaGalleryMessageMedia→MediaItemMessageContainer→ContainerMessageSection→SectionMessageSeparator→SeparatorModalLabel→LabelModalTextInput→TextInput3. Builder API Improvements
MessageBuilder:
add*prefix patternMessageBuilder.text()builder/directoryModalBuilder:
addLabel()with specific type-safe methods:addTextInput(),addSelectMenu(),addText()methodsbuilder/directory4. Enhanced MediaItem & AttachedFile API
5. Validation & Constraints
addButtons()enforces max 5 buttons per rowMediaGalleryenforces 1-10 items constraint6. Comprehensive Documentation
Added extensive documentation to
MessageBuilderandModalBuilder:7. Additional Features
api.dartandevents.dart🔄 Migration Path
package:mineral/api.dart)MessageButton→Button)text()→addText())ModalBuilder(addTextInput()vsaddLabel())Related Issue
Closes #307
Type of Change
How Has This Been Tested?
Testing approach for this refactoring:
Compilation Testing:
API Validation:
MediaItem.fromFile(),AttachedFile.fromMediaItem())Interface Implementation:
MessageComponentinterface on message componentsModalComponentinterface on modal componentsSelectMenuandTextDisplayDocumentation Review:
Backward Compatibility:
Checklist
Note: This is a breaking change release. All component names and builder APIs have been updated. Developers will need to update their code following the migration guide provided in the description.