Vencord icon indicating copy to clipboard operation
Vencord copied to clipboard

Improve plugin settings formatting (Inconsistency title&description)

Open TheGreenPig opened this issue 1 year ago • 0 comments

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

TheGreenPig avatar Sep 16 '24 21:09 TheGreenPig