From 5a3a9d04cbfd68e085a553353a193af141a19fb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barth=C3=A9lemy=20Laurans?= Date: Sun, 6 Oct 2024 18:48:09 +0200 Subject: [PATCH] [Doc] Order attribute by alphabetical order for more readability --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dd3da81..37e8ac7 100644 --- a/README.md +++ b/README.md @@ -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 \| 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 => boolean \| string \| Promise` | 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 => boolean \| string \| Promise` | 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