Skip to content

Commit 0bdeb11

Browse files
committed
Added helpful descriptions to make ui less confusing
1 parent ff312f1 commit 0bdeb11

4 files changed

Lines changed: 26 additions & 18 deletions

File tree

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@codifycli/ink-form",
33
"type": "module",
4-
"version": "0.0.3",
4+
"version": "0.0.6",
55
"description": "Complex user-friendly form component for Codify",
66
"main": "lib/index.js",
77
"exports": "./lib/index.js",
@@ -45,7 +45,8 @@
4545
"lint": "prettier --check .",
4646
"prettier:check": "prettier --check .",
4747
"prettier:write": "prettier --write .",
48-
"release": "publish-fast"
48+
"release": "publish-fast",
49+
"prepublishOnly": "tsc"
4950
},
5051
"peerDependencies": {
5152
"ink": ">=5",

src/Form.tsx

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ export const Form: React.FC<FormProps> = props => {
151151
<FormHeader {...props} headerRef={headerRef} form={form} currentTab={currentTab} onChangeTab={onChangeTab} editingField={editingField} />
152152
<ScrollArea height={fullHeight - headerHeight} key={currentTab} isStart={focusedElement === -1} numFields={sections[currentTab].fields.length} editingMode={!!editingField}>
153153
<Box flexDirection='row'>
154-
<Box flexDirection='column' width='80%'>
154+
<Box flexDirection='column' width='70%'>
155155
{!editingField && (
156156
<Box flexDirection='column'>
157157
<Box marginLeft={1} marginTop={1}>
@@ -182,27 +182,30 @@ export const Form: React.FC<FormProps> = props => {
182182
)}
183183
</Box>
184184
</Box>
185-
186-
<Box flexDirection="column">
187-
{!editingField && sections[currentTab].description && (
188-
<Box marginX={1} marginTop={1} flexDirection='column'>
189-
<Text underline>Description:</Text>
190-
<DescriptionRenderer description={sections[currentTab]?.description} />
191-
</Box>
192-
)}
185+
<Box flexDirection="column" width="30%" >
186+
{
187+
!editingField && sections[currentTab].fields[focusedElement]?.description && (
188+
<Box flexDirection="column">
189+
<Text> </Text>
190+
<Text underline>{upperFirstLetter(sections[currentTab].fields[focusedElement]?.label)}:</Text>
191+
<DescriptionRenderer description={sections[currentTab].fields[focusedElement]?.description} />
192+
</Box>
193+
)
194+
}
193195
</Box>
194196

195197
</Box>
196198
{!editingField && (
197199
<Box flexDirection='column' marginTop={1}>
198200
<Box flexDirection="row">
199-
<Button label="[A]dd resource" id={'addButton'} onClicked={() => duplicateCurrentSection()} margin={0} padding={0}/>
200-
<Button label="[R]emove resource" id={'removeButton'} isEnabled={sections.length > 1} onClicked={() => removeCurrentSection()} margin={0} padding={0}/>
201+
<Button label="[D]uplicate resource" id={'addButton'} onClicked={() => duplicateCurrentSection()}/>
202+
<Button label="[R]emove resource" id={'removeButton'} isEnabled={sections.length > 1} onClicked={() => removeCurrentSection()}/>
201203
<SubmitButton canSubmit={canSubmitForm} onSubmit={onSubmitForm}/>
202204
</Box>
205+
<Text dimColor color='gray'> Provide all required information (<Text color="red">*</Text>) to submit.</Text>
203206
<Text dimColor color='gray'> Up/down: navigate options.</Text>
204207
<Text dimColor color='gray'> Left/right: navigate between resources.</Text>
205-
<Text dimColor color='gray'> Enter: select or edit</Text>
208+
<Text dimColor color='gray'> Enter: select or edit.</Text>
206209
</Box>
207210

208211
// </Box>

src/FormHeader.tsx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,12 @@ export const FormHeader: React.FC<
3232
<Box borderStyle="double" width="100%" flexDirection="column" ref={props.headerRef}>
3333
<Box width="100%">
3434
<Box flexGrow={1}>
35-
<Text bold>{props.form.title}</Text>
36-
<Text color={'gray'}>{` (${props.form.description})`}</Text>
35+
<Text>
36+
<Text bold>{props.form.title}</Text>
37+
{ props.form.description && (
38+
<Text color={'gray'}>{` (${props.form.description})`}</Text>
39+
)}
40+
</Text>
3741
</Box>
3842
</Box>
3943
<Box width="100%">

src/demo/Test.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ export function Test() {
4040
}, 1000)
4141
}}
4242
form={{
43-
title: "codify import",
44-
description: 'some parameters are required to continue import',
43+
title: "Need more info to identify resources for import",
44+
description: 'multiples could exist',
4545
sections: [
4646
{
4747
title: "asdf-global",

0 commit comments

Comments
 (0)