Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wip] implement client dashboard api for notes #908

Merged
merged 4 commits into from
Feb 24, 2023
Merged

Conversation

icewind1991
Copy link
Member

Dashboard api will allow clients to render the dashboard widgets

See nextcloud/server#33658 for more information, requires the interfaces added by that pr

This implementation was created to provide an example for a dashboard that has a button. Interfaces might still be subject to change.

@korelstar
Copy link
Member

Nice! How can I test this (i.e. which clients will use that API)? Is it for Nextcloud Android/iOS or for the Nextcloud server itself? The last one would be interesting, too, because currently, the dashboard app loads several megabytes Javascript for every widget.

@tobiasKaminsky
Copy link
Member

It can be used by any client, but first we will implement it on Android/iOS.

@tobiasKaminsky
Copy link
Member

tobiasKaminsky commented Sep 7, 2022

Bug: iconURL is empty @icewind1991

@tobiasKaminsky
Copy link
Member

Bug: notes icon url on widgets-items endpoint is empty

@AndyScherzinger AndyScherzinger changed the title [wip] implement client dashboard api [wip] implement client dashboard api for notes Sep 7, 2022
@korelstar korelstar mentioned this pull request Oct 1, 2022
9 tasks
@juliushaertl
Copy link
Member

@tobiasKaminsky I rebased and pushed a commit to fix the icon bugs. Mind to give this another test run?

@tobiasKaminsky
Copy link
Member

In {{ base_url }}/ocs/v2.php/apps/dashboard/api/v1/widgets:
icon_url: "/nc/apps/notes/img/notes-dark.svg"

but it must be absolute, otherwise clients cannot use it.

In: {{ base_url }}/ocs/v2.php/apps/dashboard/api/v1/widget-items
iconURL: is starred.svg or notes-dark.svg
But it should provide preview of text.

image

@juliushaertl
Copy link
Member

juliushaertl commented Jan 5, 2023

I'm not sure if the previews would actually be useful here since they are quite small and you won't get the content in that size. Maybe having the star vs note icon makes more sense? @jancborchardt

icewind1991 and others added 4 commits February 2, 2023 22:17
Co-authored-by: korelstar <korelstar@users.noreply.github.com>
Signed-off-by: Tobias Kaminsky <tobias@nextcloud.com>
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature: dashboard Related to Nextcloud dashboard
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants