-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
[major] Introduce theming capacities #1323
Merged
Merged
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## release-v2 #1323 +/- ##
==============================================
+ Coverage 94.39% 94.47% +0.07%
==============================================
Files 51 53 +2
Lines 4427 4558 +131
Branches 770 777 +7
==============================================
+ Hits 4179 4306 +127
- Misses 243 247 +4
Partials 5 5 ☔ View full report in Codecov by Sentry. |
SBoudrias
force-pushed
the
theme
branch
4 times, most recently
from
January 27, 2024 20:10
b7b73b5
to
04ebde8
Compare
SBoudrias
commented
Jan 27, 2024
SBoudrias
commented
Jan 27, 2024
SBoudrias
commented
Jan 27, 2024
SBoudrias
commented
Jan 27, 2024
SBoudrias
commented
Jan 27, 2024
SBoudrias
force-pushed
the
theme
branch
7 times, most recently
from
January 28, 2024 19:39
0d9fd4e
to
0e24047
Compare
SBoudrias
added a commit
that referenced
this pull request
Mar 9, 2024
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.
This PR introduce theming capacity to Inquirer. This idea has been floating around multiple issues in the repo (#822, #1169, and others); but timing wasn't right for major API changes.
API changes
Inquirer users
From prompts user perspective, the default prompts (and hopefully the custom ones) will take an optional
theme
object config. That'll define how things are rendered.Prompts can define their own extension to the theme object for their unique rendering.
Prompt authors (and internals)
Theme-ability is introduce with the
makeTheme
small utility. A default theme is always applied, but can be extended with each prompts specific theming needs.Breaking changes
@inquirer/core
:usePrefix
interface changed@inquirer/confirm
:prefix
config is removed in favour oftheme.prefix
@inquirer/checkbox
:prefix
config is removed in favour oftheme.prefix
TODOs (to remove draft & ship)
@inquirer/core
for prompt authorsWant to help? Comment on the PR with a task you'd like to take on. Open you PR against this PR (base:
theme
)Out of scope
Though it is on my radar, I decided to not include an API to handle i18n for now. That'll likely come next with a similar config object but different internal API & types.