Skip to content

Commit 0b435e4

Browse files
committed
docs: add most properties
1 parent da3e77c commit 0b435e4

File tree

1 file changed

+63
-14
lines changed

1 file changed

+63
-14
lines changed

src/hosted/App.vue

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,25 @@
1919
v-model:historyPosition="historyPosition"
2020
v-model:query="query"
2121
:commands="commands"
22+
:help-text="helpText"
23+
:help-timeout="helpTimeout"
2224
:hide-bar="hideBar"
2325
:hide-prompt="hidePrompt"
2426
:hide-title="hideTitle"
2527
:invert="invert"
2628
:prompt="prompt"
2729
:options-resolver="optionsResolver"
2830
:show-help="showHelp"
29-
title="bash - 720x350"
30-
help-text="Type in help" />
31+
:title="title" />
3132
</div>
3233

3334
<div class="table-responsive">
34-
<table class="table ">
35+
<table class="table table-striped table-borderless">
3536
<thead>
3637
<tr>
3738
<th scope="col">
3839
Property
3940
</th>
40-
<th scope="col">
41-
Description
42-
</th>
4341
<th scope="col">
4442
Value
4543
</th>
@@ -48,28 +46,70 @@
4846
<tbody>
4947
<tr>
5048
<td><pre><code>cursor-position</code></pre></td>
51-
<td />
5249
<td>
5350
<pre><code>{{ cursorPosition }}</code></pre>
5451
</td>
5552
</tr>
5653
<tr>
5754
<td><pre><code>dispatched-queries</code></pre></td>
58-
<td>Non-empty dispatched queries</td>
5955
<td>
60-
<pre><code>{{ [...dispatchedQueries] }}</code></pre>
56+
<pre><code>{{ dispatchedQueries }}</code></pre>
57+
</td>
58+
</tr>
59+
<tr>
60+
<td><pre><code>help-text</code></pre></td>
61+
<td>
62+
<pre><code>{{ helpText }}</code></pre>
63+
</td>
64+
</tr>
65+
<tr>
66+
<td><pre><code>help-timeout</code></pre></td>
67+
<td>
68+
<pre><code>{{ helpTimeout }}</code></pre>
69+
</td>
70+
</tr>
71+
<tr>
72+
<td><pre><code>hide-bar</code></pre></td>
73+
<td>
74+
<pre><code>{{ hideBar }}</code></pre>
75+
</td>
76+
</tr>
77+
<tr>
78+
<td><pre><code>hide-prompt</code></pre></td>
79+
<td>
80+
<pre><code>{{ hidePrompt }}</code></pre>
81+
</td>
82+
</tr>
83+
<tr>
84+
<td><pre><code>hide-title</code></pre></td>
85+
<td>
86+
<input
87+
v-model="hideTitle"
88+
class="form-check-input"
89+
type="checkbox"
90+
value="">
91+
</td>
92+
</tr>
93+
<tr>
94+
<td><pre><code>help-timeout</code></pre></td>
95+
<td>
96+
<pre><code>{{ helpTimeout }}</code></pre>
97+
</td>
98+
</tr>
99+
<tr>
100+
<td><pre><code>history</code></pre></td>
101+
<td>
102+
<pre><code>{{ history }}</code></pre>
61103
</td>
62104
</tr>
63105
<tr>
64106
<td><pre><code>history-position</code></pre></td>
65-
<td>Points to the latest dispatched query entry</td>
66107
<td>
67108
<pre><code>{{ historyPosition }}</code></pre>
68109
</td>
69110
</tr>
70111
<tr>
71112
<td><pre><code>invert</code></pre></td>
72-
<td>Inverts the terminals colors</td>
73113
<td>
74114
<input
75115
v-model="invert"
@@ -80,25 +120,28 @@
80120
</tr>
81121
<tr>
82122
<td><pre><code>is-fullscreen</code></pre></td>
83-
<td>Terminal fullscreen mode</td>
84123
<td>
85124
<pre><code>{{ isFullscreen }}</code></pre>
86125
</td>
87126
</tr>
88127
<tr>
89128
<td><pre><code>prompt</code></pre></td>
90-
<td />
91129
<td>
92130
<pre><code>{{ prompt }}</code></pre>
93131
</td>
94132
</tr>
95133
<tr>
96134
<td><pre><code>query</code></pre></td>
97-
<td />
98135
<td>
99136
<pre><code>{{ query }}</code></pre>
100137
</td>
101138
</tr>
139+
<tr>
140+
<td><pre><code>title</code></pre></td>
141+
<td>
142+
<pre><code>{{ title }}</code></pre>
143+
</td>
144+
</tr>
102145
</tbody>
103146
</table>
104147
</div>
@@ -130,6 +173,8 @@ export default {
130173
setup () {
131174
const cursorPosition = ref(0)
132175
const dispatchedQueries = ref(new Set())
176+
const helpText = ref('Type in help')
177+
const helpTimeout = ref(3500)
133178
const hideBar = ref(false)
134179
const hidePrompt = ref(false)
135180
const hideTitle = ref(false)
@@ -140,6 +185,7 @@ export default {
140185
const prompt = ref(PROMPT)
141186
const query = ref('')
142187
const showHelp = ref(true)
188+
const title = ref('bash - 720x350')
143189
144190
const optionsResolver = (program, parsedQuery, setQuery) => {
145191
switch (program) {
@@ -213,6 +259,8 @@ export default {
213259
214260
cursorPosition,
215261
dispatchedQueries,
262+
helpText,
263+
helpTimeout,
216264
hideBar,
217265
hidePrompt,
218266
hideTitle,
@@ -223,6 +271,7 @@ export default {
223271
prompt,
224272
query,
225273
showHelp,
274+
title,
226275
227276
optionsResolver
228277
}

0 commit comments

Comments
 (0)