Skip to content
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

Inline comments rewrite: Theme colors #382

Closed
imswebra opened this issue May 13, 2019 · 1 comment

Comments

@imswebra
Copy link

commented May 13, 2019

While developing my own theme, I have spent some time trying to improve the inline comments for the theme colors. I have re-ordered the colors into an arrangement that makes a little more sense to me, and with the help of @Fuhrmann's theme builder, I have written comments for each individual color value.

This does not necessarily need to be the final version of these comments, but hopefully it's a good enough start to keep any further theme developers from having to figure these out on there own.

# Colors
# * Accepted formats:
#   * The following CSS formats: #RGB, #RRGGBB, rgb(R,G,B), rgba(R,G,B,A)
#     Notes:
#     * Negative values are not accepted
#     * The rgba() form is accepted but the alpha component is forced to 100%
#     * More info at https://www.w3.org/TR/css3-color/#colorunits
#   * Both "Basic" and "Extended" color keywords are supported
#     https://www.w3.org/TR/css3-color/#svg-color
# * Examples for the red color:
#     color_accent = #ff0000
#     color_accent = rgb(255, 0, 0)
#     color_accent = rgb(100%,0,0)
#     color_accent = rgb(1.0, 0, 0)
#     color_accent = red
# * Tips:
#   * the config value interpolation supported by Keypirinha may come handy
#     here as shown as an example in some of the values below.
#     Example:
#       color_title = ${color_foreground}
#   * an online tool may be helpful to vizualize the color codes
#     https://www.w3schools.com/colors/colors_picker.asp
# * General Colors:
#   * "color_background" is the background color of the LaunchBox's container
#   * "color_foreground" is the main font color used in the LaunchBox
#   * "color_textbox_back" is the background textbox color for the typed text
#   * "color_faded" is a legacy value that has no effect, but should be defined
#     in your theme for consistency.
# * List Colors:
#   * "color_listitem_back" is the background color for the listed items
#   * "color_listitem_title" is the text color of a listed item's title
#   * "color_listitem_desc" is the text color of a listed item's description
#   * "color_listitem_tips" is the color of a listed item's tips (Dial numbers,
#     the number of actions, etc.)
# * Selection Colors:
#   * "color_accent" is the color used by "list_selmark", the selection
#     indicator
#   * "color_listitem_selected_back" is the background color for the selected
#     item
#   * "color_listitem_selected_title" is the text color of the selected item's
#     title
#   * "color_listitem_selected_desc" is the text color of the selected item's
#     description
#   * "color_listitem_selected_tips" is the color of a listed item's tips (Dial
#     numbers, the number of actions, etc.)
# * Other Colors:
#   * "color_title" is the color used by the title in actions view (top left
#     text when you "ctrl+enter" on a selected item)
#   * "color_status" is the color used by "status", the bottom status bar
#   * "color_warn" is the color used by ERROR items
#
#color_background = #484848
#color_foreground = #f2f2f2
#color_textbox_back = #303030
#color_faded = #a2a2a2
#
#color_listitem_back = #383838
#color_listitem_title = ${color_foreground}
#color_listitem_desc = ${color_faded}
#color_listitem_tips = ${color_faded}
#
#color_accent = #a6e5ff
#color_listitem_selected_back = #2f2f2f
#color_listitem_selected_title = ${color_accent}
#color_listitem_selected_desc = ${color_foreground}
#color_listitem_selected_tips = ${color_accent}
#
#color_title = ${color_foreground}
#color_status = ${color_faded}
#color_warn = #eb6420

My only other suggestions would maybe be some variable reworking, but I understand that backwards compatibility is important. Considering that any theme can declare their own local variables, maybe having color_legacy being required for distribution is unnecessary. I also find color_titled to be a little unintuitive, though I don't have any better suggestions other than color_actions_title. Finally, if we are being nitpicky, maybe color_listitem_selected_x could be shortened to something like color_selecteditem_x, but that's very minor.

Thanks as always for your continued support!

@polyvertex

This comment has been minimized.

Copy link
Member

commented Aug 18, 2019

Change applied in release v2.24, thanks!

@polyvertex polyvertex closed this Aug 18, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.