Skip to content

Commit e2ae768

Browse files
committed
docs: add notes about DS, usage and features
1 parent a27ad57 commit e2ae768

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
node_modules
22
dist
3+
coverage
4+
styleguide

README.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,27 @@ const validationFn = val => {
5858

5959
<ExpressionBuilder
6060
onChangeFn={onChangeFn}
61-
expressionRootClass={expressionRootClass}
62-
expressionInputClass={expressionInputClass}
6361
options={options}
64-
placeholder="Enter your expression"
62+
expressionRootClass={expressionRootClass} // Optional
63+
expressionInputClass={expressionInputClass} // Optional
64+
placeholder="Enter your expression" // Optional
6565
initialFocus={true} // if you want your input to be focussed on mount by default
66-
validationFn={validationFn}
66+
validationFn={validationFn} // Optional
6767
/>
6868

6969
```
7070

71+
### Features
72+
73+
- Typeahead support
74+
- Full keyboard navigation and deletion
75+
- Easy custom styling as per input
76+
- Input validation at granular level
77+
78+
### Data Structure
79+
80+
Uses an N-Ary tree to contain the expression data, simple recursive function gives you the complete string. Y
81+
7182
## Author
7283

7384
[Anshuman Verma](https://github.com/anshumanv)

src/Test.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const stringRegex = /"([^\\"]|\\")*"/
99
const cb1 = () => alert('valid!')
1010
const cb2 = () => alert('invalid!')
1111

12-
const onChangeFn = st => console.log('change', st)
12+
const onChangeFn = st => console.log('change', st.buildExpression())
1313
const expressionRootClass = 'root-class'
1414
const expressionInputClass = 'input-class'
1515

0 commit comments

Comments
 (0)