Skip to content

Documentation changes for v4.3.1 #10

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.

Sign up for GitHub

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

Merged
jakeboone02 merged 5 commits into from
May 21, 2022
Merged

Documentation changes for v4.3.1 #10

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bbbac4d
Add documentation on placeholder props and compat library props
jakeboone02 May 19, 2022
647c804
Update Schema interface documentation
jakeboone02 May 19, 2022
d0ff0e7
Change placeholder(Field|Operator)Name from props to translations
jakeboone02 May 20, 2022
abe0649
Add CodeSandbox example links and fix placeholderName documentation
jakeboone02 May 20, 2022
9e0bf57
Use JSON when appropriate
jakeboone02 May 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update Schema interface documentation
  • Loading branch information
@jakeboone02
jakeboone02 committed May 19, 2022
commit 647c804b87b95c219c4ddb7a17efe5ba503194a8
5 changes: 4 additions & 1 deletion docs/typescript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface Field {
id?: string; // The field identifier (if not provided, then `name` will be used)
name: string; // REQUIRED - the field name
label: string; // REQUIRED - the field label
operators?: NameLabelPair[]; // Array of operators (if not provided, then `getOperators()` will be used)
operators?: NameLabelPair[] | OptionGroup[]; // Array of operators (if not provided, then `getOperators()` will be used)
valueEditorType?: ValueEditorType; // Value editor type for this field (if not provided, then `getValueEditorType()` will be used)
inputType?: string | null; // Input type for text box inputs, e.g. 'text', 'number', or 'date' (if not provided, then `getInputType()` will be used)
values?: NameLabelPair[]; // Array of values, applicable when valueEditorType is 'select' or 'radio' (if not provided, then `getValues()` will be used)
Expand Down Expand Up @@ -226,6 +226,9 @@ interface Schema {
showNotToggle: boolean;
showCloneButtons: boolean;
autoSelectField: boolean;
placeholderFieldName: string;
autoSelectOperator: boolean;
placeholderOperatorName: string;
addRuleToNewGroups: boolean;
enableDragAndDrop: boolean;
validationMap: ValidationMap;
Expand Down