From ad6c6b8863a6f0e42976e6b128c2eff7d0bcd94d Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Sun, 27 Apr 2025 11:44:46 +0200 Subject: [PATCH] chore: deprecate export of filepicker Vue component Signed-off-by: Ferdinand Thiessen --- CHANGELOG.md | 6 ++++++ README.md | 4 ++++ lib/filepicker.ts | 4 +++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ce29d0007..aafe3d8e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ All notable changes to this project will be documented in this file. +## UNRELEASED +### Notes + +The export of the file picker Vue component is deprecated and will be removed in the next version. +Instead please use the `FilePickerBuilder`. + ## 6.1.1 [Full Changelog](https://github.com/nextcloud-libraries/nextcloud-dialogs/compare/v6.1.0...v6.1.1) diff --git a/README.md b/README.md index ec2030d29..3d080f102 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,10 @@ const paths = await filepicker.pick() ``` #### Use the Vue component directly + +> [!WARNING] +> The Vue component is deprecated and will no longer be exported in a future version. + We also provide the `@nextcloud/dialogs/filepicker.js` entry point to allow using the Vue component directly: ```vue diff --git a/lib/filepicker.ts b/lib/filepicker.ts index 24b0dd5d4..c6df466d8 100644 --- a/lib/filepicker.ts +++ b/lib/filepicker.ts @@ -1,10 +1,12 @@ -/** +/*! * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors * SPDX-License-Identifier: AGPL-3.0-or-later */ /** * This entry points provides access to the FilePicker Vue component and its type definitions + * + * @deprecated The file picker Vue export will be removed in a future version. Please only use the file picker builder. */ export { FilePickerVue } from './components/FilePicker/index.js'