package
Nextcloud dialog helpers
npm install @nextcloud/dialogsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
skjnldsv
skjnldsv@protonmail.com
Nextcloud dialog helpers
npm i -S @nextcloud/dialogs@nextcloud/dialogs | maintained | @nextcloud/vue dependency | Nextcloud server version |
|---|---|---|---|
| 7.x | ✅ | 9.x (Vue 3)¹ | Nextcloud 31 and newer |
| 6.x | ✅ | 8.x | Nextcloud 29, 30, 31, 32 |
| 5.x | ❌ | 8.x | Nextcloud 28, 29, 30 |
| 4.2+ | ❌ | 7.12² | Nextcloud 25, 26, 27, 27.1 |
| 4.1 | ❌ | any | any up to Nextcloud 30 |
¹: In version 7.x the @nextcloud/vue dependency is moved to dependencies so you can also use this library
with an old version of @nextcloud/vue in your app dependencies if your app still uses Vue 2.
Note that this might increase the bundled app size.
If your app also already uses @nextcloud/vue version 9.x and Vue 3 then the bundle size will not increase.
²: Since version 4.2 this package provides a Vue.js based file picker, so this package depends on @nextcloud/vue.
The styles for the components (Toasts and FilePicker) are imported automatically by the package entry points.
Your bundler has to support importing CSS files from JavaScript (e.g. Vite, or Webpack with css-loader).
import { showMessage, showInfo, showSuccess, showWarning, showError } from '@nextcloud/dialogs'If your app only needs toasts, you can import them from the @nextcloud/dialogs/toast entry point instead.
(Note: Webpack issue - bundler might include other components source, e.g. the FilePicker, in the app):
import { showError } from '@nextcloud/dialogs/toast'If you using @nextcloud/dialogs >= 4.0 you don't need any svg or scss loader in you projects anymore.
There are different toast styles available, that are exposed in separate functions:
showMessage('Message without a specific styling')
showInfo('Information')
showSuccess('Success')
showWarning('Warning')
showError('Error')There are several options that can be passed in as a second parameter, like the timeout of a toast:
showError('This is an error shown without a timeout', { timeout: -1 })Ordinary toasts (success, error, warning, info, and bare messages) use the user-configured toast timeout
from the theming capabilities (theming.toastTimeout) when available, and fall back to
TOAST_DEFAULT_TIMEOUT (7 seconds) otherwise.
Loading toasts stay permanent until hidden manually, and undo toasts keep their fixed undo duration.
A full list of available options can be found in the documentation.
Toasts are displayed in the bottom start corner of the page and are shifted by the width of the app navigation when it is open.
Apps can adjust the toasts position with a CSS variable, the value is added to the default distance to the bottom (default: 0px):
:root {
--toast-offset-block-end: 80px;
}To spawn the FilePicker provided by the library you have to use the FilePickerBuilder. The FilePickerBuilder is included in the main entry point of this library, so you can use it like this:
import { getFilePickerBuilder } from '@nextcloud/dialogs'
const filepicker = getFilePickerBuilder('Pick plain text files')
.addMimeTypeFilter('text/plain')
.addButton({
label: 'Pick',
callback: (nodes) => console.log('Picked', nodes),
})
.build()
// You get the file nodes by the button callback, but also the pick yields the paths of the picked files
const paths = await filepicker.pick()For testing all components provide data-testid attributes as selectors, so the tests are independent from code or styling changes.
data-testid | Intended purpose |
|---|---|
select-all-checkbox | The select all checkbox of the file list |
file-list-row | A row in the file list (tr), can be identified by data-filename |
row-checkbox | Checkbox for selecting a row |
row-name | Name of the row / file |
main or stableXv4.0.1): git checkout -b v<version>npm version patch --no-git-tag-version (npm version minor --no-git-tag-version if minor).
This will return a new version name, make sure it matches what you expectgenerate then paste the content to the CHANGELOG.md file
npm run prerelease:format-changelog.
This will apply this regex: by @([^ ]+) in ((https://github.com/)nextcloud-libraries/nextcloud-dialogs/pull/(\d+))
Which this as the replacement: [\#$4]($2) \([$1]($3$1)\)v4.0.1)
Estimated unpacked size across 63 packages.
35.2 MB+
Includes dependencies.
17 direct dependencies.
^3.5.44
3.5.45
^5.11.0
5.11.0
^7.4.47
7.4.47
^10.0.0
10.0.0
^15.0.0
15.0.0
^2.6.0
2.6.0
^4.0.0
4.1.1
^3.1.0
3.1.0
^3.2.0
3.2.0
^0.4.0
0.4.0
^3.3.3
3.3.3
^1.2.1
1.2.1
^3.0.0
3.0.0
0.5.0