Add Export Link widget #1997

doekenorg · 2024-02-26T15:20:14Z

This PR addresses #1891.

It adds a CSV (or TSV) download link widget with a label and option to wrap inside a <p> tag.

![disabled](https://github.com/GravityKit/GravityView/assets/529515/cb62a001-d07a-4f37-8b0c-9d4bdc04a209)

zackkatz · 2024-02-26T17:01:02Z

@doekenorg Thanks, this is a good start!

A few things I noticed upon review:

Add a setting: "Include all entries" or "Include visible entries". If all entries, it would strip search args. Otherwise, it would keep the search args, but add &csv=1 or &tsv=1 to them.
Make sure the link works when Prevent Direct Access is checked
When "Allow export" is disabled, show a message in the widget that exporting isn't enabled for the View and provide a JS-connected button to enables it.

A couple of questions:

How will this work with DataTables layout?
~~How do you suggest implementing the GravityExport functionality as described in the ticket "Detect if there are GravityExport feeds. For each feed: Enable/disable, Allow customizing link text"~~
Can you see if using add_query_arg()/remove_query_arg() would be a more compatible with the items above than get_permalink()?
There's a View setting "Show all in file"—how should we handle this in the widget UI?

zackkatz · 2024-02-26T17:04:57Z

This is related to #1560 as well, since we want to integrate an icon picker.

doekenorg · 2024-02-26T17:08:07Z

@zackkatz Ehlers and I noted that the GravityExport support doesn't really make sense here. I created a different issue on that repo to make a separate widget. I feel like it doesn't belong in the gravityview repo.

I'll look into the rest.

doekenorg · 2024-02-27T13:05:20Z

@doekenorg Thanks, this is a good start!

A few things I noticed upon review:

Add a setting: "Include all entries" or "Include visible entries". If all entries, it would strip search args. Otherwise, it would keep the search args, but add &csv=1 or &tsv=1 to them.

Make sure the link works when Prevent Direct Access is checked

When "Allow export" is disabled, show a message in the widget that exporting isn't enabled for the View and provide a JS-connected button to enables it.

A couple of questions:

How will this work with DataTables layout?

~~How do you suggest implementing the GravityExport functionality as described in the ticket "Detect if there are GravityExport feeds. For each feed: Enable/disable, Allow customizing link text"~~

Can you see if using add_query_arg()/remove_query_arg() would be a more compatible with the items above than get_permalink()?

There's a View setting "Show all in file"—how should we handle this in the widget UI?

@zackkatz I think I'm a little lost here.

This issue is to create a link to the regular view csv / tsv, because people forget to add the correct link. So I'm not sure where these settings are coming from. There are no search parameters. If Prevent Direct Access is checked or if you are on an embeded view, you cannot use that link. There is also no way around this using the REST API for example, because you are not allowed to view the entries if the direct access is denied.

As for datatables, that looks like a whole different ballgame. I don't think this issue and that feature relate to each other.

I can fix the javascript you mentioned, and make sure it also looks for prevent direct access, but other than that; I'm not sure this is the correct issue.

zackkatz · 2024-02-29T01:59:34Z

@doekenorg Nice! Good start. Cool to see the nonce working.

It's not currently passing along the search query to the REST URL, so it doesn't only download searched entries

On the View URL https://dev.test/view/training-plan/?filter_99=.co.uk&mode=any (searching field id 99), the CSV link is currently https://dev.test/wp-json/gravityview/v1/views/45/entries.csv?_nonce=63953260d4. It should be passing along the search parameters (https://dev.test/wp-json/gravityview/v1/views/45/entries.csv?_nonce=63953260d4&filter_99=.co.uk&mode=any).

All entries are being downloaded, even when "Show all in output" is not checked. This may be because of the REST endpoint instead of the /csv/ View endpoint. What do you think we should do here?
It's rendering the <p> tags for me. I built the CSS and JS and cleared the browser cache. Note: I renamed the widget, which is why it's named something different.

With Export disabled:

Export enabled:

What do you think I'm missing?

doekenorg · 2024-03-04T15:45:47Z

@zackkatz I've fixed the issues at hand (and removed a bunch of warnings from unit tests). As for All entries are being downloaded. I kinda did that on purpose. So I can remove that, and make it follow the logic that it needs Show all in file enabled as well. I'm just not sure if that makes sense for this feature. Personally, I would assume it downloads all results. Not just the ones currently in view.

So we can either make that explicit with a notice on the widget. Or we can make it follow the same logic as /csv. I'm fine with either.

We need to formalize this, but I think we should use our own methods, when we have them available, so that we can implement optimizations.

- Open in same window - Define `download` attribute to provide browser hinting - Add `type` attribute for MIME type hinting In addition, I: - Switched from sprintf() to strtr() for readability - Updated the sanitization functions to match content type https://accessabilly.com/proposal-for-a-more-accessible-download-link/ https://www.nngroup.com/articles/new-browser-windows-and-tabs/#pdfs-and-other-nonhtml-documents

$value can be an array. Since we don't use it, removing the strict type hinting here doesn't matter.

I wanted to update the link URL when searching via DataTables, and it wasn't possible because the link didn't have any default CSS class. To match existing widget structure, I'm adding a `<div>` wrapper.

This allows easy modification in DataTables for when searches are performed.

zackkatz · 2024-03-13T04:04:00Z

This should be released in concert with a DataTables change: https://github.com/GravityKit/DataTables/commit/c95170578e57920c87ec22f200e6a66a357174b1

…-easily-used-in-the-view

zackkatz · 2024-03-13T04:07:23Z

@doekenorg I'm not clear on what "An entry link was added to the CSV output." means in the changelog. Can you elaborate?

doekenorg · 2024-03-13T07:55:31Z

@doekenorg I'm not clear on what "An entry link was added to the CSV output." means in the changelog. Can you elaborate?

@zackkatz oh sorry. When downloading a CSV with the REST API, there was an <a> tag around the value of the field that linked to the entry.

crbdev · 2024-03-15T08:26:45Z

Works well for me 👍

…-easily-used-in-the-view

doekenorg self-assigned this Feb 28, 2024

doekenorg force-pushed the feature/1891-implement-a-csv-widget-to-be-easily-used-in-the-view branch 3 times, most recently from 646ce64 to 30b08e7 Compare March 4, 2024 14:00

doekenorg force-pushed the feature/1891-implement-a-csv-widget-to-be-easily-used-in-the-view branch from 993c431 to 8ab3cf1 Compare March 4, 2024 18:45

doekenorg added 8 commits March 7, 2024 14:30

Add CSV download link widget

df96317

no capital Link

e4eea1f

Move CSV download to REST endpoint with nonce check.

535a0ad

Fix unit test warnings

52f43c1

Add classes, allow field name headers, strip notice.

8cd307f

update image

93228e7

Fix styling with new name. Hide export until allowed.

0871618

Transfer search query params to export link.

7519a97

doekenorg force-pushed the feature/1891-implement-a-csv-widget-to-be-easily-used-in-the-view branch from 8ab3cf1 to 7519a97 Compare March 7, 2024 13:32

doekenorg and others added 10 commits March 7, 2024 14:40

Add notification all entries will be downloaded by widget

6757731

Add translations

8419d72

Use Utils::get() instead of rgar()

4e67815

We need to formalize this, but I think we should use our own methods, when we have them available, so that we can implement optimizations.

Fix punctuation

31add4b

Tweak the language a bit

be28c72

Use the same language as other field settings (for now)

c38d961

Fix fatal error when Search Bar has multiselect

8923f32

$value can be an array. Since we don't use it, removing the strict type hinting here doesn't matter.

Update language for the widget

ad4cd7e

Add container div to improve styling/scripting

0378ec2

I wanted to update the link URL when searching via DataTables, and it wasn't possible because the link didn't have any default CSS class. To match existing widget structure, I'm adding a `<div>` wrapper.

zackkatz added 3 commits March 13, 2024 11:27

Fix mime type

4dbbdc6

Provide the base URL for JS updating

2803710

This allows easy modification in DataTables for when searches are performed.

Fix incorrect variable name

d638a48

Merge branch 'develop' into feature/1891-implement-a-csv-widget-to-be…

10ca055

…-easily-used-in-the-view

zackkatz requested review from mrcasual and zackkatz March 13, 2024 04:08

zackkatz approved these changes Mar 13, 2024

View reviewed changes

Update readme.txt [ci skip]

a4f04bd

zackkatz changed the title ~~Add CSV download link widget~~ Add Export Link widget Mar 18, 2024

Merge branch 'develop' into feature/1891-implement-a-csv-widget-to-be…

b93d9e3

…-easily-used-in-the-view

mrcasual merged commit 9e134c8 into develop Mar 18, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Export Link widget #1997

Add Export Link widget #1997

doekenorg commented Feb 26, 2024 •

edited

Loading

zackkatz commented Feb 26, 2024 •

edited by doekenorg

Loading

zackkatz commented Feb 26, 2024

doekenorg commented Feb 26, 2024

doekenorg commented Feb 27, 2024

zackkatz commented Feb 29, 2024 •

edited

Loading

doekenorg commented Mar 4, 2024

zackkatz commented Mar 13, 2024

zackkatz commented Mar 13, 2024

doekenorg commented Mar 13, 2024

crbdev commented Mar 15, 2024

Add Export Link widget #1997

Add Export Link widget #1997

Conversation

doekenorg commented Feb 26, 2024 • edited Loading

zackkatz commented Feb 26, 2024 • edited by doekenorg Loading

zackkatz commented Feb 26, 2024

doekenorg commented Feb 26, 2024

doekenorg commented Feb 27, 2024

zackkatz commented Feb 29, 2024 • edited Loading

doekenorg commented Mar 4, 2024

zackkatz commented Mar 13, 2024

zackkatz commented Mar 13, 2024

doekenorg commented Mar 13, 2024

crbdev commented Mar 15, 2024

doekenorg commented Feb 26, 2024 •

edited

Loading

zackkatz commented Feb 26, 2024 •

edited by doekenorg

Loading

zackkatz commented Feb 29, 2024 •

edited

Loading