Skip to content

Improve plugin settings formatting (Inconsistency title&description)#2884

Merged
Nuckyz merged 3 commits into
Vendicated:devfrom
TheGreenPig:settings-consistency
Sep 22, 2024
Merged

Improve plugin settings formatting (Inconsistency title&description)#2884
Nuckyz merged 3 commits into
Vendicated:devfrom
TheGreenPig:settings-consistency

Conversation

@TheGreenPig
Copy link
Copy Markdown
Contributor

Description

This PR addresses the inconsistencies in how plugin settings are displayed across different OptionTypes.

Problem:

  1. For the boolean OptionType (Switch), both the setting title (i.e., the formatted setting ID) and the description are displayed. However, for all other OptionTypes, only the description is shown, leading to inconsistency. This can be confusing for plugin devs.
  2. The use of "Description" implies that plugin developers should explain the setting's purpose and functionality in more detail. As a result, descriptions tend to be longer than typical setting titles, which can make settings with lengthy descriptions appear overwhelming when used as a title.

Solution:

This small PR standardizes the formatting by ensuring that both the setting title and description are displayed across all setting types, not just for the boolean OptionType.

Comparison

Before (current)

Example-before

After

Example-after

Copy link
Copy Markdown
Owner

@Vendicated Vendicated left a comment

Choose a reason for hiding this comment

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

i definitely agree that it's confusing that the description is used as title and the name itself isn't displayed anywhere and the fact that this is inconsistent with boolean settings

but i think in its current state it also looks a bit odd

Comment thread src/components/PluginSettings/components/SettingSelectComponent.tsx Outdated
Co-authored-by: v <vendicated@riseup.net>
@Nuckyz
Copy link
Copy Markdown
Collaborator

Nuckyz commented Sep 22, 2024

This might make some plugin settings confusion as the author did not use a proper setting name due to it not being part of the component before. I think we should just wait for a proper settings rewrite in the future

@Nuckyz
Copy link
Copy Markdown
Collaborator

Nuckyz commented Sep 22, 2024

This might make some plugin settings confusion as the author did not use a proper setting name due to it not being part of the component before. I think we should just wait for a proper settings rewrite in the future

I just changed my mind and found a case where the missing setting name made me confused, will merge this :)

@Nuckyz Nuckyz changed the base branch from main to dev September 22, 2024 07:37
@Nuckyz Nuckyz enabled auto-merge (squash) September 22, 2024 07:38
@Nuckyz Nuckyz merged commit 517f751 into Vendicated:dev Sep 22, 2024
@Nuckyz
Copy link
Copy Markdown
Collaborator

Nuckyz commented Sep 22, 2024

Thanks!!

Autumnlight02 pushed a commit to Autumnlight02/Vencord that referenced this pull request Sep 27, 2024
josiauh pushed a commit to josiauh/Vencord that referenced this pull request Sep 28, 2024
Johannes7k75 pushed a commit to Johannes7k75/Vencord that referenced this pull request Jan 13, 2025
…cated#2624)

Co-authored-by: vee <vendicated@riseup.net>

friendsSince: add support for new profiles (Vendicated#2623)

Co-authored-by: vee <vendicated@riseup.net>

WebContextMenus: implement context menu for text selection (Vendicated#2577)

Co-authored-by: vee <vendicated@riseup.net>

improve settings ui

ctrlEnterSend: fix for new Discord update (Vendicated#2647)

improve settings ui (again)

feat(plugins): ConsoleJanitor (Vendicated#2659)

Fix ShowAllRoles

Delete WikiSearch ~ better done via user app

https://discord.com/application-directory/search?q=wiki

Delete UrbanDictionary ~ better done via user app

https://discord.com/application-directory/search?q=urban

MessageLogger: fix not blurring deleted spoilers

fix(MessageLogger): don't break attachment edits

bump to v1.9.4

BetterNotes: fix crashing

Fix broken patches

Fix broken patches/finds

CtrlEnterSend: fix for new Discord update (Vendicated#2689)

Co-authored-by: vee <vendicated@riseup.net>

Fix broken experiments patch

new plugin MentionAvatars: Shows user avatars inside mentions (Vendicated#2691)

InvisibleChat: fix embeds missing decrypted content (Vendicated#2655)

fix(FakeNitro): do not convert applicable twitch sub emotes

fix(ShowMeYourName) - proper case insensitive name comparison (Vendicated#2633)

Co-authored-by: vee <vendicated@riseup.net>

fix(MessageLogger edits): render with proper guild context

MessageLogger: add compact display of history & edit modal (Vendicated#2299)

Co-authored-by: vee <vendicated@riseup.net>

MessageLogger: fix edit modal close button

fix badges on canary

MentionAvatars: fix mentions being ultra wide in topics

WhoReacted: fix errors

Fix loading scientific notation chunks

fix PictureInPicture on canary

Fix ImageZoom, SpotifyControls and ViewIcons (Vendicated#2723)

Co-authored-by: Vendicated <vendicated@riseup.net>

bump to v1.9.6

feat(showHiddenChannels): Fix Broken Patch (Vendicated#2726)

fix(ShowHiddenThings): always render highest role in ModView (Vendicated#2709)

feat(plugins/openInApp) Refactor code and add Apple Music support (Vendicated#2744)

Co-authored-by: v <vendicated@riseup.net>
Co-authored-by: Shiggy <136832773+shiggybot@users.noreply.github.com>

XSOverlay: Update to new API (Vendicated#2736)

Co-authored-by: v <vendicated@riseup.net>

Fix MessagePopoverAPI patch (Vendicated#2746)

Co-authored-by: Nuckyz <61953774+Nuckyz@users.noreply.github.com>

Fix ShowConnections

Co-Authored-By: Masterjoona <69722179+Masterjoona@users.noreply.github.com>

fix BetterUploadButton on canary

MutualGroupDms: make display consistent with Mutual Servers (Vendicated#2727)

Co-authored-by: Cookie <52550063+Covkie@users.noreply.github.com>

fix(BetterFolders): Close folders when switching accounts (Vendicated#2748)

MentionAvatars: Add option to hide @ symbol(Vendicated#2725)

Co-authored-by: v <vendicated@riseup.net>

Decor: add copy preset id button (Vendicated#2737)

Co-authored-by: v <vendicated@riseup.net>

Translate: Add DeepL support (Vendicated#2721)

Co-authored-by: v <vendicated@riseup.net>

fix: Add ViewRaw & MessageLogger context menu options on threads (Vendicated#2750)

new plugin YoutubeAdblock: blocks ads in embeds (formerly WatchTogetherAdblock)

FakeProfileThemes: fix crash when encountering invalid colours (Vendicated#2714)

ShowHiddenThings: Fix ModView highest role fix (Vendicated#2747)

bump to v1.9.7

Migrate to eslint flat config; update dependencies (Vendicated#2627)

Co-authored-by: vee <vendicated@riseup.net>

XSOverlay: Return old API for compatibility (Vendicated#2753)

Fix broken patches

fix message hover buttons

fix YoutubeAdblock not working for some users

fix message hover buttons... again

delete MaskedLinkPaste ~ now a stock Discord feature

fix MutualGroupDMs

fix PictureInPicture (Vendicated#2773)

Co-authored-by: v <vendicated@riseup.net>

build: improve errors when breaking module boundaries

fix(SpotifyControls): sync with external shuffle toggles  (Vendicated#2767)

Co-authored-by: v <vendicated@riseup.net>

Fix ShowHiddenThings feature & PauseInvitesForever

Decor: Fix on current user area

Fix Online Themes tab (Vendicated#2786)

feat(Webpack): Add $$vencordPatchedSource to patched factories

fix(Webpack): Not canonicalizing regex in some places

[Webkeybinds] Don't override browser keybinds (Vendicated#2792)

Delete AutomodContext ~ Now a stock feature

Fix persisting $$vencordPatchedSource when a module is loaded again

delete ShowAllRoles ~ now a stock feature

Remove obsolete patches for old profiles (Vendicated#2800)

Co-authored-by: Nuckyz <61953774+Nuckyz@users.noreply.github.com>

PermissionsViewer: Fix user popout

Fix ViewIcons and NoProfileThemes

MemberCount: add thread support (Vendicated#2785)

Co-authored-by: v <vendicated@riseup.net>

new plugin NoMaskedLinkPaste (Vendicated#2782)

Co-authored-by: v <vendicated@riseup.net>

PronounDB: Fix on user profiles

ReviewDB: Add view review button to other profiles types

Add missing methods to ExpressionPickerStore

bump to v1.9.8

MoreUserTags: fix settings ui logic

Co-authored-by: Vendicated <vendicated@riseup.net>

MentionAvatars: Also display role icons in role mentions (Vendicated#2801)

Co-authored-by: Vendicated <vendicated@riseup.net>

Fix PermissionsViewer on user popouts

new plugin AlwaysExpandRoles ~ Alternative to ShowAllRoles (Vendicated#2809)

ConsoleJanitor: Remove non needed patch

notosans no longer errors

Fix settings wrapping fallback

IgnoreActivities: Add option for blacklist filter (Vendicated#2712)

SuperReactionTweaks: Allow disabling Super Reactions (Vendicated#2805)

Add ts-pattern as @webpack/common

TimeBarAllActivities: Support new activity cards (Vendicated#2813)

new plugin CopyFileContents ~Easily copy text file attachments contents (Vendicated#2790)

PatchHelper: Add Copy as Codeblock button (Vendicated#2820)

new plugin StickerPaste ~ Insert stickers instead of sending (Vendicated#2781)

VolumeBooster: Support browser and Vesktop (Vendicated#2730)

OpenInApp: Add support for localization in Spotify URL regex (Vendicated#2776)

Bump to 1.9.9

VolumeBooster: Fix on Vesktop (Vendicated#2828)

Also fixed an IgnoreActivities patch and added a README to it

PermissionsViewer: Show RoleIcons & which role grants permission (Vendicated#2824)

MutualGroupDMs: Add Mutual Groups to DM Sidebar (Vendicated#2817)

Allow online themes to be applied only in dark or light mode (Vendicated#2701)

Ban ts-pattern normal import

ReviewDB: Fix wording in server reviews (Vendicated#2826)

PronounDB: Fix patched pronoun tooltip (Vendicated#2832)

NoServerEmojis: Fix detecting server emojis (Vendicated#2835)

SecretRingToneEnabler: Option to always play Snow Halation Theme (Vendicated#2831)

VolumeBooster: Fix playing sound in wrong output device (Vendicated#2840)

Fix BetterFolders and FriendsSince

Dearrow: Add option to not dearrow by default (Vendicated#2818)

Dearrow: Fix thumbnails with default option

fix crashing on canary when searching slash commands (Vendicated#2844)

MemberCount: fix null safety

and improve types for PopoutPosition

Co-Authored-By: fres621 <126067139+fres621@users.noreply.github.com>

XSOverlay: fix profile images (Vendicated#2788)

Fixes Vendicated#2787

Co-authored-by: v <vendicated@riseup.net>

MentionAvatars: Fix compatibility with ServerInfo plugin

bump to v1.10.1

fix Commands, Badges, RoleColorEverywhere

TimeBarAllActivities: Fix not working (Vendicated#2847)

CustomRPC: Fix activity preview styling

Fix SortFriendRequests received date

new plugin AccountPanelServerProfile (Vendicated#2836)

NoTrack: Fix blocking analytics (Vendicated#2857)

TimeBarAllActivities: Fix timestamp component

BetterFolders: Fix pending clan applications (Vendicated#2867)

AppleMusicRichPresence: fix metadata fetching (Vendicated#2864)

OpenInApp: support Spotify prerelease links (Vendicated#2870)

delete TimeBarAllActivites ~ now a stock feature

delete NoDefaultHangStatus ~ Removed feature

UserVoiceShow: Fix for simplified profiles

AppleMusicRichPresence: fix formatting when listening to radio (Vendicated#2869)

Co-authored-by: Ryan Cao <70191398+ryanccn@users.noreply.github.com>
Co-authored-by: v <vendicated@riseup.net>

BetterSettings: Add submenu for plugins (Vendicated#2858)

Co-authored-by: Vendicated <vendicated@riseup.net>

ReviewDB: Fix in panel profile

Experiments: Allow clips to be recorded without streaming

remove need to depend on CommandsAPI

add Icons to webpack commons

SearchReply => FullSearchContext ~ now adds all options back

UserVoiceShow: Fix setting name

clearURLs: Add si@soundcloud.com to rule list (Vendicated#2890)

ShowHiddenThings: fix discovery keyword filter bypass

UserVoiceShow: Better support for DM channels

Bump to 1.10.2

UserVoiceShow: Show in messages

ReviewDB: Fix in panel profile (again)

OpenInApp: Fix opening in spotify activity cards for web (Vendicated#2894)

ReplaceGoogleSearch: Fix DuckDuckGo URL (Vendicated#2895)

CopyFileContents: Add padding to button (Vendicated#2848)

RoleColorEverywhere: Add coloring to message contents (Vendicated#2893)

ConsoleJanitor: Ignore all loggers with whitelist (Vendicated#2896)

Fix plugin settings inconsistency regarding setting names (Vendicated#2884)

PronounDB: Rework API to avoid rate limits

UserVoiceShow: Fix showing hidden channels

RoleColorEverywhere: add chat message colour toggle

PronounDB: Fix crashing

FullSearchContext: Re-add Copy Author ID

FakeNitro: Fix wrongfully allowed emojis in voice calls (Vendicated#2901)

RoleColorEverywhere: Fix unneeded restart on setting change (Vendicated#2899)

UserVoiceShow: Fix incorrect dependencies

BetterFolders: Fix sidebar in wrong location (Vendicated#2904)

ContextMenuAPI: Fix findGroupChildrenByChildId

add Live indicator

add me

CustomIdle: fix crash on canary

Fix multiple plugins for latest Discord update (Vendicated#2911)

Co-authored-by: Nuckyz <61953774+Nuckyz@users.noreply.github.com>
Co-authored-by: thororen1234 <78185467+thororen1234@users.noreply.github.com>

bump to v1.10.3

Optimize slow patches

VolumeBooster: fix stream on web based clients (Vendicated#2916)

Co-authored-by: v <vendicated@riseup.net>

Fix required plugins being shown as disabled

BlurNSFW: Fix not blurring embeds (Vendicated#2862)

PermissionsViewer: Fix profile button (Vendicated#2925)

NoBlockedMessages: Fix conflict with MessageLogger (Vendicated#2921)

Fix multiple plugins (again)

Bump to 1.10.4

Add Activity Icons

add Tags and add me as Dev

Revert "Voice activity"

add YouTube Music controls

fix YouTube Music comp.

Delete src/plugins/YoutubeMusicControls directory

add ytm controls

new plugin FixImagesQuality

Add icon to userscript meta (Vendicated#2936)

SupportHelper: fix DM warning card

MessageClickActions: Fix editing messages which failed to send (Vendicated#2677)

ShowHiddenChannels: Fix re-organizing channels (Vendicated#2942)

Workaround electron/electron#43367

Fix ShowHiddenChannels & FakeNitro broken functionality (Vendicated#2959)

Rework PronounDB -> UserMessagesPronouns

Fix ViewIcons & plugins that use image modals

Co-Authored-By: sadan <117494111+sadan4@users.noreply.github.com>

Fix ImageZoom

Also fixes the image modal being off centre when having the plugin enabled

Co-Authored-By: sadan <117494111+sadan4@users.noreply.github.com>

fix MutualGroupDMs (Vendicated#2964)

Co-authored-by: v <vendicated@riseup.net>

"fix" OpenInApp

ArmCord -> Legcord (Vendicated#2948)

bump to v1.10.5

ImageZoom: Fix when multiple images with carrousel (Vendicated#2966)

Co-authored-by: Nuckyz <61953774+Nuckyz@users.noreply.github.com>

ConsoleJanitor: Brush react-spring deprecation (Vendicated#2973)

Fix plugins using ImageModals (again)

NoPendingCount: Fix hiding offers count (Vendicated#2975)

remove unused code

ShowHiddenChannels: Fix viewing voice channels (Vendicated#2979)

ThemeAttributes: fix freezing when changing avatar

Fix settings & updater for Canary

Fix all plugins for new i18n lib (Vendicated#2993)

Bump to 1.10.6

NoBlockedMessages: Fix for new i18n lib (Vendicated#2996)

intl macro: Support raw hash

Decor: Fix crashing

BetterFolders: Fix try-catch with no effect (Vendicated#3000)

PatchHelper: Prevent trailing comma error (Vendicated#2913)

TypingTweaks: Fix crashing in some languages (Vendicated#2998)

Fix misc plugins errors on account switch

Revert "Decor: Fix crashing"

cd3a998.

NoTrack: Remove obsolete patch

Settings: Fix fallback patch

Bump to 1.10.7

Decor: Prevent crashing from useUserDecorAvatarDecoration

Decor: Fix avatar decorations not showing

This reverts & edits commit 3b295e1.

Decor: Prevent more crashes

FakeNitro: Fix embedding animated emojis (Vendicated#3012)

AlwaysExpandRoles: Fix collapse roles button not appearing

ViewIcons: Fix conflict with unread Group DMs (Vendicated#3011)

NoMosaic: Fix plugin not working in Canary

ChunkLoader: Avoid CSS debugging chunk

Actually stop searching for CSS debugging chunk

ShikiCodeblocks: Updated codeblocks themes (Vendicated#3013)

PictureInPicture: Fix button not showing up (Vendicated#3014)

ViewRaw: Add support for Group DMs (Vendicated#3010)

RoleColorEverywhere: Poll Results & Cleanup

Co-authored-by: jamesbt365 <jamesbt365@gmail.com>

Decor: Update notice about joining the server for clarity (Vendicated#3021)

RoleColorEverywhere: Fix Online/Offline

 Fix OpenInApp & ShowHiddenThings

Decor: Fix avatar decorations not showing (again) (Vendicated#3025)

ShowHiddenChannels: Fix viewing voice channels (Vendicated#3033)

EmoteCloner: Fix recognizing animated emojis (Vendicated#3027)

Remove no-longer desired collaborator (Vendicated#3032)

RoleColorEverywhere: Fix message headers colors (Vendicated#3036)

Update to newer Discord icons in Vencord Settings (Vendicated#3029)

Add support for onAuxClick on ChatBarButton (Vendicated#3043)

ShowHiddenThings: Allow opening mod view on yourself (Vendicated#3045)

SilentTyping: Improve button visual look (Vendicated#3026)

PermissionsViewer: Fix permission description tooltip & cleanup (Vendicated#3040)

BetterFolders: Fix dedicated sidebar (Vendicated#3037)

WebContextMenus: Fix copy context menu

Update CONTRIBUTING.md

Plugins interacting with specific Discord bots are not allowed.

Badges: fix overflow in Discord's css

ImageZoom: Fix zoom level not saving (Vendicated#3054)

Bump to 1.10.8

MessagePopoverAPI: Add buttons after quick reactions

ServerListIndicators: Account for pending clans count

AlwaysTrust: Fix disabling suspicious file popup

CommandsAPI: Fix spread overwriting omitted subcommand options (Vendicated#3057)

CommandHelpers: Make findOption use nullish coalescing (Vendicated#3047)

MutualGroupDMs: Fix in DM sidebar when no mutual friends/servers (Vendicated#2976)

WebContextMenus: Fix input bar menu

NoScreensharePreview: Migrate to stock Discord feature

BetterFolders: Fix including open folders in main sidebar (Vendicated#3064)

CallTimer: fix crashing on canary

NoScreensharePreview: Allow plugin to be turned on/off

Remove old plugin migrations

Fix TypingIndicator & CallTimer

Remove workaround for Devtools theme

BetterFolders: Fix folder icon setting

TypingTweaks: Fix plugin

ConsoleJanitor: Add HLJS deprecations (Vendicated#3062)

TypingTweaks: Fix usernames not being colored (Vendicated#3070)

Fix multiple plugins for latest Discord update (Vendicated#3072)

FavoriteEmojiFirst: Fix sorting emojis (Vendicated#3074)

AppleMusicRichPresence: Fix token fetching Regex (Vendicated#3071)

PinDMs: Fix duplicate channels

NoTrack: Make hasClientMods return false

Bump to 1.10.9

PinDMs: Fix real time updating when changing settings

use correct prodversion in chrome extension installer

ShowHiddenThings: Discovery filter bypass is patched

Filtering is now done server-side in Discord

QuickReply: Prevent caret from moving when selecting message (Vendicated#3104)

OpenInApp: Add support for geo.music.apple.com links (Vendicated#3101)

NoUnblockToJump: Also allow jump for ignored users (Vendicated#3110)

new plugin FullUserInChatbox (Vendicated#2766)

SpotifyControls: Setting to restart playing song if playtime >3s (Vendicated#3103)

ConsoleShortcuts: Add openModal and openModalLazy (Vendicated#3118)

PictureInPicture: Fix picture in picture button (Vendicated#3120)

Add React eslint & update depencenies (Vendicated#3090)

Co-authored-by: Nuckyz <61953774+Nuckyz@users.noreply.github.com>

BetterFolders: Fix dedicated sidebar (Vendicated#3129)

PinDMs: Fix real time updating when changing settings

again...

MessagePopoverAPI: Fix buttons not appearing

BetterFolders: Fix for Discord Canary build (Vendicated#3133)

Revert "MessagePopoverAPI: Fix buttons not appearing"

I didn't mean to push this yet

Reapply "MessagePopoverAPI: Fix buttons not appearing"

Actually applying the fix this time

remove changes in wrong file

remove wrong code changes
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.

3 participants