Skip to content

Commit

Permalink
[Doc] Order attribute by alphabetical order for more readability
Browse files Browse the repository at this point in the history
  • Loading branch information
Bartheleway committed Oct 6, 2024
1 parent ec8513e commit 5a3a9d0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ const answer = await tableMultiple({

| Property | Type | Required | Description | Default |
| - | - | - | - | - |
| message | `string` | yes | The question to ask. |
| allowUnset | `boolean` | no | If `multiple` is set to false and this one to `true`, you can unselect the selected choice. | `false`
| columns | `(TableQuestionColumn<Value> \| TableColumn)[]` | yes | The list of columns to display. |
| rows | `(TableRow \| Separator)[]` | yes | The list of rows. Each row offer a choice which can be multiple (radio vs checkbox vs checkbox-multi) based on the `mode` option. |
| validate | `TableAnswers<Value> => boolean \| string \| Promise<string \| boolean>` | no | On submit, validate the answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
| pageSize | `number` | no | The number of lines to display. | `7` |
| loop | `boolean` | no | Indicate if you can loop over table rows. | `true`
| message | `string` | yes | The question to ask. |
| multiple | `boolean` | no | Indicate if rows allows multiple choices or not. | `false`
| allowUnset | `boolean` | no | If `multiple` is set to false and this one to `true`, you can unselect the selected choice. | `false`
| pageSize | `number` | no | The number of lines to display. | `7` |
| required | `boolean` | no | Indicate if at least one choice is necessary. | `false`
| loop | `boolean` | no | Indicate if you can loop over table rows. | `true`
| rows | `(TableRow \| Separator)[]` | yes | The list of rows. Each row offer a choice which can be multiple (radio vs checkbox vs checkbox-multi) based on the `mode` option. |
| validate | `TableAnswers<Value> => boolean \| string \| Promise<string \| boolean>` | no | On submit, validate the answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |

## Columns

Expand Down

0 comments on commit 5a3a9d0

Please sign in to comment.