{"id":19725633,"url":"https://github.com/xdev-software/vaadin-grid-exporter","last_synced_at":"2025-04-30T00:31:26.307Z","repository":{"id":53709613,"uuid":"521144682","full_name":"xdev-software/vaadin-grid-exporter","owner":"xdev-software","description":"Makes it possible to export Vaadin Grids to different formats","archived":false,"fork":false,"pushed_at":"2025-04-28T04:17:43.000Z","size":5980,"stargazers_count":28,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-28T05:25:03.075Z","etag":null,"topics":["grid-exporter","vaadin","vaadin-grid-exporter"],"latest_commit_sha":null,"homepage":"https://vaadin.com/directory/component/gridexporter-for-vaadin","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xdev-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-08-04T06:09:52.000Z","updated_at":"2025-04-24T11:32:45.000Z","dependencies_parsed_at":"2024-03-25T09:26:02.823Z","dependency_job_id":"8a2a6f29-a0f4-4598-8c84-3703767d80fe","html_url":"https://github.com/xdev-software/vaadin-grid-exporter","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xdev-software","download_url":"https://codeload.github.com/xdev-software/vaadin-grid-exporter/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251607723,"owners_count":21616825,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grid-exporter","vaadin","vaadin-grid-exporter"],"created_at":"2024-11-11T23:31:52.474Z","updated_at":"2025-04-30T00:31:26.301Z","avatar_url":"https://github.com/xdev-software.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/gridexporter-for-vaadin)\n[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-grid-exporter?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-grid-exporter)\n[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-grid-exporter/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-grid-exporter/actions/workflows/check-build.yml?query=branch%3Adevelop)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-grid-exporter\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-grid-exporter)\n![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)\n\n# GridExporter for Vaadin\n\nThe Vaadin Grid Exporter can convert nearly any Vaadin Grid to a variety of formats.\u003cbr/\u003e\nThis way you don't have to copy the Grid contents manually or print the whole website with the Grid.\n\nOut of the box supported formats:\n* CSV\n* Word (DOCX)\n* HTML\n* ODS\n* ODT\n* PDF\n* PowerPoint (PPTX)\n* RTF\n* Plain text\n* Excel (XLSX)\n\n_These formats are exported using [dynamicreports](https://github.com/xdev-software/dynamicreports-core-for-grid-exporter)._\n\nIt's also easy to extend the Exporter to support your custom format.\n\n![demo](assets/preview.gif)\n\n\u003e [!NOTE]\n\u003e \u003cdetails\u003e\u003csummary\u003e\u003cb\u003eDisclaimer about the scope of this component\u003c/b\u003e (click to expand)\u003c/summary\u003e\n\u003e\n\u003e Although the GridExporter can handle most use-cases, extreme scenarios will likely impact performance, usability and might require some hacks.\u003cbr/\u003e\n\u003e For such cases custom written exports are recommended e.g. by utilizing JasperReports directly.\u003cbr/\u003e\n\u003e If you need help implementing these feel free to [contact us](#support) or open a [question](https://github.com/xdev-software/vaadin-grid-exporter/issues/new?assignees=\u0026labels=question\u0026projects=\u0026template=question.yml) if you are not sure that the GridExporter is a good option for your scenario.\n\u003e\n\u003e \u003c/details\u003e\n\n## Usage\n\nDefault usage:\n\n```java\nGridExporter\n\t.newWithDefaults(this.grExamples)\n\t.open();\n```\n\nCustom format (see [JsonGridExporterProvider from Demo](vaadin-grid-exporter-demo/src/main/java/software/xdev/vaadin/gridexport/example/jsonext/JsonGridExporterProvider.java)):\n\n```java\nGridExporter\n\t.newWithDefaults(this.grExamples)\n\t.loadFromProvider(new JsonGridExporterProvider())\n\t.open();\n```\n\n## Installation\n\n[Installation guide for the latest release](https://github.com/xdev-software/vaadin-grid-exporter/releases/latest#Installation)\n\n### Comaptibility with  ``CSP`` (Content-Security-Policy) and ``X-Frame-Options``\n\n\u003e [!TIP]\n\u003e In Spring Security the [default value of ``X-Frame-Options`` is ``DENY``](https://docs.spring.io/spring-security/reference/features/exploits/headers.html#headers-frame-options) which will break the preview if not changed.\n\nTo show the preview the [CSP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) or the [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) (deprecated in favor of CSP) must be configured in a way that they allow showing same-site elements.\n\nThis can be achieved by:\n* setting the CSP to include at least ``frame-ancestors 'self'`` and maybe additionally ``object-src 'self'``\n* setting ``X-Frame-Options`` to ``SAMESITE``.\u003cbr/\u003eIf you use Spring Security without a CSP the easiest way to set this is:\n    ```java\n    http.headers(c -\u003e c.frameOptions(HeadersConfigurer.FrameOptionsConfig::sameOrigin));\n    ```\n\n\u003e [!NOTE]\n\u003e Depending on the browser the settings sometimes have slightly different effects.\u003cbr/\u003e\n\u003e For example Firefox blocks the preview due to privacy reasons when ``X-Frame-Option=DENY`` and ``Content-Security-Policy=frame-ancestors 'self'; object-src 'self'; ...`` but Chrome does not.\n\n### Compatibility with Vaadin\n\n| Vaadin version | GridExporter version |\n| --- | --- |\n| Vaadin 24+ (latest) | ``3+`` |\n| Vaadin 23 | ``2.x`` |\n\n### Compatibility with JasperReports\n\nStarting with version [3.1.0](./CHANGELOG.md#310) JasperReports 7 is required.\n\n### Spring-Boot\n* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)\n\n## Run the Demo\n* Checkout the repo\n* Run ``mvn install \u0026\u0026 mvn -f vaadin-grid-exporter-demo spring-boot:run``\n* Open http://localhost:8080\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow example\u003c/summary\u003e\n  \n  ![demo](assets/demo.avif)\n\u003c/details\u003e\n\n## Support\nIf you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).\n\n## Contributing\nSee the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.\n\n## Dependencies and Licenses\nView the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-grid-exporter/dependencies)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-grid-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdev-software%2Fvaadin-grid-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-grid-exporter/lists"}