docs(file-picker): add @since

capawesome-team · Jan 16, 2024 · a61e487 · a61e487
1 parent 5bf165c
commit a61e487
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/packages/file-picker/README.md b/packages/file-picker/README.md
@@ -273,13 +273,13 @@ Remove all listeners for this plugin.
 
 #### PickMediaOptions
 
-| Prop                  | Type                 | Description                                                                                                                              | Default                        |
-| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
-| **`multiple`**        | <code>boolean</code> | Whether multiple files may be selected.                                                                                                  | <code>false</code>             |
-| **`readData`**        | <code>boolean</code> | Whether to read the file data.                                                                                                           | <code>false</code>             |
-| **`skipTranscoding`** | <code>boolean</code> | Whether to avoid transcoding, if possible. On iOS, for example, HEIC images are automatically transcoded to JPEG. Only available on iOS. | <code>false</code>             |
-| **`limit`**           | <code>number</code>  | The maximum number of files that the user can select. This option is ignored if `multiple` is set to `false`. Only available on iOS.     | <code>0 (unlimited)</code>     |
-| **`ordered`**         | <code>boolean</code> | Whether an ordered number is displayed instead of a check mark in the selection badge. Only available on iOS &gt;= 15.                   | <code>false (checkmark)</code> |
+| Prop                  | Type                 | Description                                                                                                                              | Default                    | Since |
+| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ----- |
+| **`multiple`**        | <code>boolean</code> | Whether multiple files may be selected.                                                                                                  | <code>false</code>         |       |
+| **`readData`**        | <code>boolean</code> | Whether to read the file data.                                                                                                           | <code>false</code>         |       |
+| **`skipTranscoding`** | <code>boolean</code> | Whether to avoid transcoding, if possible. On iOS, for example, HEIC images are automatically transcoded to JPEG. Only available on iOS. | <code>false</code>         |       |
+| **`limit`**           | <code>number</code>  | The maximum number of files that the user can select. This option is ignored if `multiple` is set to `false`. Only available on iOS.     | <code>0 (unlimited)</code> |       |
+| **`ordered`**         | <code>boolean</code> | Whether an ordered number is displayed instead of a check mark in the selection badge. Only available on iOS (15+).                      | <code>false</code>         | 5.3.0 |
 
 
 #### PluginListenerHandle

diff --git a/packages/file-picker/src/definitions.ts b/packages/file-picker/src/definitions.ts
@@ -231,9 +231,10 @@ export interface PickMediaOptions {
   /**
    * Whether an ordered number is displayed instead of a check mark in the selection badge.
    *
-   * Only available on iOS >= 15.
+   * Only available on iOS (15+).
    *
-   * @default false (checkmark)
+   * @default false
+   * @since 5.3.0
    */
   ordered?: boolean;
 }