Implement Vue based Dialogs especially the FilePicker

[susnux]

• Resolves Ship own filepicker code #1
• Resolves Vue-Rewrite? #301

Done ✔️

• Write reusable Vue Dialog component
• Implement FilePicker as a Vue Dialog
• Implement suggested improvements
  • Remember last path (File picker: remember last location/folder you were in, not start in root folder every time nextcloud/server#39186)
  • A similar layout to the settings modal is used to mimic the files app layout, with a navigation on the left containing
    • All files
    • Recent
    • Favorites
  • If "All files" is chosen, the breadcrumbs are shown with the file list
  • [x]If "Recent" is chosen, a heading "Recent items" is shown and the recent files list
  • If "Favorites" is chosen, a heading "Favorites" and the list of favorites
  • The new breadcrumbs component is used
    • ⚠️ There are errors in the console, but they seem to come from the vue component itself.
  • Remove the lines in between each item
  • File picker: ability to filter nextcloud/server#39187 : the first item of the navigation can be a search bar which allows you to search for a file (across all your files)
• Loading placeholders similar to the text app
• Write legacy wrapper so the new FilePicker can be used with the same API, we just need to switch the function call in server core.

Todo 🚧

(in a follow up)

• Move the Dialog and DialogButton to @nextcloud/vue
• Implement Grid view
• Load view order from files app API (File picker: use same sort order as in the main Files view nextcloud/server#39185)
• Proper tests
• (Not related but still a todo 😉 ) Enforce eslint rules

Screenshots

vokoscreenNG-2023-08-10_04-21-53.mp4

And on smaller screens:

[susnux]

cc @nimishavijay

[skjnldsv]

Follow-up: checkboxes should be hidden when picking a destination?

[skjnldsv]

Insane work btw!!
I think we should do a design review session as a followup

[AndyScherzinger]

Awesome work @susnux - left open is then the server-PR to make use of it via a lib bump I guess?

[raimund-schluessler]

• The new breadcrumbs component is used

  • ⚠️ There are errors in the console, but they seem to come from the vue component itself.

Nice to see the component is finally being used somewhere. Are the error something I can help with?

[skjnldsv]

Nice to see the component is finally being used somewhere

Also in the new Files app 🚀

[susnux]

@raimund-schluessler

Are the error something I can help with?

The mounted hook fails because getWidth throws an error, my current guess is that the function uses .elm on vnodes which is not always defined. But I will open an issue on the vue repository with some tracing :)

[susnux]

@AndyScherzinger

Awesome work @susnux - left open is then the server-PR to make use of it via a lib bump I guess?

Thank you, yes we need a new (4.2.0-beta.1 ?) release. The PR is already prepared (~6 lines of code to change) so that is used everywhere :)

[AndyScherzinger]

Yes, can you create a tag? @skjnldsv, me or any team lead can then create the release to trigger the npm publishing part.

[juliushaertl]

Wow. So nice to see this finally happend. Great work @susnux 💙

[raimund-schluessler]

Is there some documentation how to use the new filepicker? I try with an app that used the old filepicker like this:

const file = await getFilePickerBuilder('Pick a file').build().pick()

but that still leads to the old picker.

And using the new picker directly via import { FilePickerVue } from '@nextcloud/dialogs' and e.g. showing it with v-if leads to an error regarding buttons:

TypeError: a.buttons is undefined
    r FilePicker-d6e48816.mjs:166
    VueJS 3
    i FilePicker-d6e48816.mjs:166
    VueJS 4
    xt FilePicker-d6e48816.mjs:185
    VueJS 32
    ru Attachments.vue:1
    VueJS 7
vue.runtime.esm.js:3049:8

I obviously do something wrong here, so the documentation would be helpful 🙂

[AndyScherzinger]

@susnux knows best and already integrated it in the files app.

[AndyScherzinger]

See nextcloud/server#39792 for an example @raimund-schluessler

[susnux]

Is there some documentation how to use the new filepicker?

Currently not, vue files broke Typedoc. I will have to figure out how to document vue files with typedoc. Planned this for the next dialogs release.

I try with an app that used the old filepicker like this:

const file = await getFilePickerBuilder('Pick a file').build().pick()

but that still leads to the old picker.

Yes the FilePicker builder still relays on the OC.dialogs variable so only shows the new FilePicker for 27.1.0-beta currently.
This is also planned to migrate to always use the provided filepicker instead of using the global variable.

And using the new picker directly via import { FilePickerVue } from '@nextcloud/dialogs' and e.g. showing it with v-if leads to an error regarding buttons:
...
I obviously do something wrong here, so the documentation would be helpful 🙂

You are missing the buttons property which currently (!) looks like this:

type IFilePickerButtons = Array<IFilePickerButton>

interface IFilePickerButton {
    // The button text
    label: string
    // Optional button icon (as a Vue component), recommend to use the AsyncComponent factory
    icon?: Component | AsyncComponen
    // Same as NcButton
    type: string
    // callback on click
    callback: (nodes: Node[]) => void
}

[raimund-schluessler]

Yes the FilePicker builder still relays on the OC.dialogs variable so only shows the new FilePicker for 27.1.0-beta currently. This is also planned to migrate to always use the provided filepicker instead of using the global variable.

That is weird, I tried it with latest master of server, but still the old picker.

You are missing the buttons property which currently (!) looks like this:

type IFilePickerButtons = Array<IFilePickerButton>

interface IFilePickerButton {
    // The button text
    label: string
    // Optional button icon (as a Vue component), recommend to use the AsyncComponent factory
    icon?: Component | AsyncComponen
    // Same as NcButton
    type: string
    // callback on click
    callback: (nodes: Node[]) => void
}

Thanks for the hint. I am not used to the composition api yet, but I will try to figure out how to provide the buttons property.

[susnux]

That is weird, I tried it with latest master of server, but still the old picker.

Yes currently only in 27.1.0 beta, master PR is still pending :/

Thanks for the hint. I am not used to the composition api yet, but I will try to figure out how to provide the buttons property.

Just provide a the Filepicker the buttons, like

<template>
<FilePicker :buttons="buttons" ... />
</template>
<script>
// ...
export default {
 data() {
    return {
        buttons: [{ label: 'Pick', callback: (nodes) => console.log('picked nodes:', nodes) }]
    }
  }
// ...
}
</script>

[raimund-schluessler]

@raimund-schluessler

Are the error something I can help with?

The mounted hook fails because getWidth throws an error, my current guess is that the function uses .elm on vnodes which is not always defined. But I will open an issue on the vue repository with some tracing :)

@susnux See nextcloud-libraries/nextcloud-vue#4416