feat(components): support premium buttons #1276
Open
Conversation
This file contains 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
This updates the workaround added in 41618b1, which attempts to preserve the row of url buttons. This already technically worked for premium buttons too, but only due to a bug in that previous implementation. Still, this remains an awful workaround. It may be easier to only update the components directly, and leave `self.children` as is, ignoring additions/removals (which shouldn't happen here in the first place). Alternatively, the new `id` field could also work, though it's currently still part of that other thing and not public.
shiftinv
added
t: enhancement
|
Can we please model SKU and URL buttons as distinct types 🙏 |
Enegg
reviewed
Jan 23, 2025
| @@ -53,7 +53,7 @@ class Button(Item[V_co]): | |||
| The style of the button. | |||
| custom_id: Optional[:class:`str`] | |||
| The ID of the button that gets received during an interaction. | |||
| If this button is for a URL, it does not have a custom ID. | |||
| If this button is for a URL or an SKU, it does not have a custom ID. | |||
There was a problem hiding this comment.
Suggested change
| If this button is for a URL or an SKU, it does not have a custom ID. | |
| If this button is for a URL or a SKU, it does not have a custom ID. |
There was a problem hiding this comment.
I believe this was brought up at some point before; it depends on whether one pronounces "SKU" as individual letters (i.e. "S - K - U") or as one word (i.e. something like "skew"), and both are apparently valid:
- https://dictionary.cambridge.org/pronunciation/english/sku
- https://en.wiktionary.org/wiki/SKU (includes IPA for both)
I personally tend more towards the former pronounciation, and it's in line with the (admittedly few) occurrences already in the library, but the latter would be correct too, as far as I can tell.
| @@ -169,7 +183,7 @@ def style(self, value: ButtonStyle) -> None: | |||
| def custom_id(self) -> Optional[str]: | |||
| """Optional[:class:`str`]: The ID of the button that gets received during an interaction. | |||
|
|
|||
| If this button is for a URL, it does not have a custom ID. | |||
| If this button is for a URL or an SKU, it does not have a custom ID. | |||
There was a problem hiding this comment.
Suggested change
| If this button is for a URL or an SKU, it does not have a custom ID. | |
| If this button is for a URL or a SKU, it does not have a custom ID. |
| @@ -184,7 +184,7 @@ class Button(Component): | |||
| The style of the button. | |||
| custom_id: Optional[:class:`str`] | |||
| The ID of the button that gets received during an interaction. | |||
| If this button is for a URL, it does not have a custom ID. | |||
| If this button is for a URL or an SKU, it does not have a custom ID. | |||
There was a problem hiding this comment.
Suggested change
| If this button is for a URL or an SKU, it does not have a custom ID. | |
| If this button is for a URL or a SKU, it does not have a custom ID. |
Co-authored-by: Eneg <42005170+Enegg@users.noreply.github.com> Signed-off-by: vi <8530778+shiftinv@users.noreply.github.com>
|
I suppose |
yup, thanks! 0636ffe |
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.
Summary
This adds support for premium buttons via
ButtonStyle.premiumandui.Button.sku_id, and deprecatesInteractionResponse.require_premium1.discord/discord-api-docs@4853fbc
Checklist
pdm lintpdm pyrightFootnotes
Looks like this response type does not work at all anymore, contrary to the documentation and changelog, which claim "This will continue to function but may be eventually unsupported.". This makes it already a breaking change on Discord's end, so no point in making it even more breaking here. Still, it could honestly just be removed. ↩