-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow downloading/copying data from the slice editor.
PiperOrigin-RevId: 500739910
- Loading branch information
Showing
7 changed files
with
221 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #export-controls { | ||
| display: inline-block; | ||
| } | ||
|
|
||
| .above { | ||
| --popup-bottom: 28px; | ||
| } | ||
|
|
||
| .icon-button { | ||
| font-size: 18px; | ||
| vertical-align: middle; | ||
| margin-left: 3px; | ||
| margin-bottom: 5px; | ||
| } | ||
|
|
||
| .download-button { | ||
| margin: 4px 0 0 0; | ||
| width: 100%; | ||
| } | ||
|
|
||
| popup-container.download-popup { | ||
| display: inline-block; | ||
| --popup-right: 0; | ||
| } | ||
|
|
||
| .download-popup-controls { | ||
| align-items: center; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| /** | ||
| * @fileoverview A resusable component for downloading data in LIT | ||
| * @license | ||
| * Copyright 2022 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| // tslint:disable:no-new-decorators | ||
| import './popup_container'; | ||
|
|
||
| import {html} from 'lit'; | ||
| import {classMap} from 'lit/directives/class-map'; | ||
| import {customElement, property} from 'lit/decorators'; | ||
| import {observable} from 'mobx'; | ||
| import * as papa from 'papaparse'; | ||
|
|
||
| import {ReactiveElement} from '../lib/elements'; | ||
| import {styles as sharedStyles} from '../lib/shared_styles.css'; | ||
|
|
||
| import {styles} from './export_controls.css'; | ||
| import {PopupContainer} from './popup_container'; | ||
| import {SortableTableEntry} from './table'; | ||
|
|
||
| /** | ||
| * An element that handles logic for downloading data. | ||
| */ | ||
| @customElement('export-controls') | ||
| export class ExportControls extends ReactiveElement { | ||
| static override get styles() { | ||
| return [sharedStyles, styles]; | ||
| } | ||
|
|
||
| /** The default file download name. */ | ||
| @observable @property({type: String}) downloadFilename: string = 'data.csv'; | ||
| /** A list of rows of data to download. */ | ||
| @property({type: Object}) data: SortableTableEntry[][] = []; | ||
| /** Column names. */ | ||
| @observable @property({type: Object}) columnNames: string[] = []; | ||
| /** Download popup position defaults to below the download icon. */ | ||
| @property({type: String}) popupPosition: string = 'below'; | ||
| /** If true, disable controls. */ | ||
| @property({type: Boolean}) disabled = false; | ||
|
|
||
| getCSVContent(): string { | ||
| return papa.unparse( | ||
| {fields: this.columnNames, data: this.data}, | ||
| {newline: '\r\n'}); | ||
| } | ||
|
|
||
| getPopupClasses() { | ||
| return classMap({ | ||
| 'hidden': this.disabled, | ||
| 'download-popup': true, | ||
| 'above': this.popupPosition === 'above' | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Renders the copy and download buttons to download data. | ||
| */ | ||
| override render() { | ||
| const copyCSV = () => { | ||
| const csvContent = this.getCSVContent(); | ||
| navigator.clipboard.writeText(csvContent); | ||
| }; | ||
|
|
||
| const downloadCSV = () => { | ||
| const csvContent = this.getCSVContent(); | ||
| const blob = new Blob([csvContent], {type: 'text/csv'}); | ||
| const a = window.document.createElement('a'); | ||
| a.href = window.URL.createObjectURL(blob); | ||
| a.download = this.downloadFilename; | ||
| document.body.appendChild(a); | ||
| a.click(); | ||
| document.body.removeChild(a); | ||
| const controls: PopupContainer = | ||
| this.shadowRoot!.querySelector('popup-container.download-popup')!; | ||
| controls.expanded = false; | ||
| }; | ||
|
|
||
| const updateFilename = (e: Event) => { | ||
| // tslint:disable-next-line:no-any | ||
| this.downloadFilename = (e as any).target.value as string; | ||
| }; | ||
|
|
||
| function onEnter(e: KeyboardEvent) { | ||
| if (e.key === 'Enter') downloadCSV(); | ||
| } | ||
|
|
||
| const iconClass = classMap({ | ||
| 'icon-button': true, | ||
| 'mdi-outlined': true, | ||
| 'disabled': this.disabled, | ||
| }); | ||
|
|
||
| // clang-format off | ||
| return html` | ||
| <div id='export-controls'> | ||
| <mwc-icon class=${iconClass} | ||
| title="Copy ${this.data.length} rows as CSV" | ||
| @click=${copyCSV}> | ||
| file_copy | ||
| </mwc-icon> | ||
| <popup-container class='${this.getPopupClasses()}'> | ||
| <mwc-icon class=${iconClass} slot='toggle-anchor' | ||
| title="Download ${this.data.length} rows as CSV"> | ||
| file_download | ||
| </mwc-icon> | ||
| <div class='download-popup-controls'> | ||
| <label for="filename">Filename</label> | ||
| <input type="text" name="filename" value=${this.downloadFilename} | ||
| @input=${updateFilename} @keydown=${onEnter}> | ||
| <button class='download-button filled-button nowrap' | ||
| @click=${downloadCSV} | ||
| ?disabled=${!this.downloadFilename}> | ||
| Download ${this.data.length} rows | ||
| </button> | ||
| </div> | ||
| </popup-container> | ||
| </div>`; | ||
| // clang-format on | ||
| } | ||
| } | ||
|
|
||
| declare global { | ||
| interface HTMLElementTagNameMap { | ||
| 'export-controls': ExportControls; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.