1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# Style
Each `InquirerPy` prompt contains several [components](#components) which you can
[customise](#customising-style) the style.
## Customising Style
```{seealso}
Checkout [Default Style](#default-style) for all available style classes to customise.
```
### Classic Syntax (PyInquirer)
```{tip}
`InquirerPy` also supports style customisation via ENV variables. Checkout {ref}`ENV <pages/env:Style>` documentation.
```
The entry point function {ref}`pages/prompt:prompt` has a parameter `style` which you can use to apply custom styling using {class}`dict`.
```
from InquirerPy import prompt
result = prompt(
{"message": "Confirm order?", "type": "confirm", "default": False},
style={"questionmark": "#ff9d00 bold"},
vi_mode=True,
style_override=False,
)
```
The parameter `style_override` can be used to remove all [Default Style](#default-style). Value is `True` by default.
```
from InquirerPy import prompt
result = prompt(
{"message": "Confirm order?", "type": "confirm", "default": False},
style={"questionmark": "#ff9d00 bold"},
vi_mode=True,
style_override=True,
)
```
### Alternate Syntax
```{eval-rst}
When using the :ref:`index:Alternate Syntax`, each `prompt` class requires a :class:`~InquirerPy.utils.InquirerPyStyle` instance instead of a dictionary. You can get
this object by using :func:`~InquirerPy.utils.get_style`.
.. autofunction:: InquirerPy.utils.get_style
:noindex:
```
## Default Style
```{note}
The default style is based on [onedark](https://github.com/joshdick/onedark.vim/blob/master/colors/onedark.vim) color palette.
```
Checkout [Components](#components) to see how the following styles are applied to each `prompt`.
```python
{
"questionmark": "#e5c07b",
"answermark": "#e5c07b",
"answer": "#61afef",
"input": "#98c379",
"question": "",
"answered_question": "",
"instruction": "#abb2bf",
"long_instruction": "#abb2bf",
"pointer": "#61afef",
"checkbox": "#98c379",
"separator": "",
"skipped": "#5c6370",
"validator": "",
"marker": "#e5c07b",
"fuzzy_prompt": "#c678dd",
"fuzzy_info": "#abb2bf",
"fuzzy_border": "#4b5263",
"fuzzy_match": "#c678dd",
"spinner_pattern": "#e5c07b",
"spinner_text": "",
}
```
## Color Syntax
Applying basic style.
```python
{
"questionmark": "blue"
}
```
Coloring both foreground and background.
```python
{
"questionmark": "fg:#e5c07b bg:#ffffff"
}
```
Adding additional styles to text.
```python
{
"questionmark": "fg:#e5c07b bg:#ffffff underline bold"
}
```
## Available Options
### Colors
- [ANSI color palette](https://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html#8-colors): `ansired`
- Named color: `red`
- Hexadecimal notation: `#ffffff`
### Text
- `underline`
- `italic`
- `bold`
- `reverse`
- `hidden`
- `blink`
### Negative Variants
- `noblink`
- `nobold`
- `nounderline`
- `noreverse`
- `nohidden`
- `noitalic`
## Support
The styling functionality leverages [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit).
For more reference of the styling options, visit `prompt_toolkit` [documentation](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/styling.html).
The colors and styling support will be limited by the terminal and font and experience may vary between different environments. Avoid
adding styles such as `italic` since lots of font or terminal doesn't support it.
## Components
|
