Skip to content

Commit

Permalink
Adding PDF Viewer sample (#569)
Browse files Browse the repository at this point in the history
Adding PDF Viewer sample to the Typescript samples.  This PDF Viewer sample allows pdfs to be viewed using a dashboard network extension.  It makes use of extension-apis around settings, dialogs, and parameters.

The sample adds support for testing using jest and adding React components from tableau-ui.  Adding support for tableau-ui requires React versions to match so had to move this project's react from 17.0.2 to 16.8.6.  React-types didn't have a 16.8.6 version so went with the previous version of 16.8.5.
  • Loading branch information
b-carver authored Dec 20, 2024
1 parent 0629f28 commit 8004ee0
Show file tree
Hide file tree
Showing 20 changed files with 9,323 additions and 2,300 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ dist/

# Ignore IDE specific files
.idea

# Ignore test coverage files
coverage/
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,26 @@ If you want to use TypeScript to write your extensions, you can run a script tha

**npm run dev**

* To automatically build the TypeScript samples whenever code change.

**npm run build-watch**

For more information, see [Use TypeScript with the Extensions API](https://tableau.github.io/extensions-api/docs/core/trex_typescript).

#### Typescript Development in PdfViewer Sample

* To run tests for the PdfViewer sample.

**npm run test**

* To automatically run tests for the PdfViewer sample whenever code changes.

**npm run test-watch**

* To run test code coverage for the PdfViewer sample.

**npm run test-coverage**

### Sandboxed Extension Development Environment

Tableau is introducing development support for Sandboxed Extensions with Tableau 2019.3. Sandboxed Extensions run in a virtual sandbox and ensure the extension can’t make network calls outside of the hosting Tableau Server. The Extensions API SDK provides a local development environment that replicates the Tableau Hosting Cloud Service for Sandboxed Extensions. You can test your Sandboxed extensions locally with the same sandbox policies.
Expand Down
8 changes: 8 additions & 0 deletions Samples-Typescript/Dashboard/PdfViewer/Messages.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export const unconfiguredExtensionMessage = 'Add a PDF using \'Configure\' in the object menu.';
export const urlInputText = 'Enter the URL for PDF';
export const urlIsNotValidErrorMessage = 'URL is not valid, please add a different PDF using \'Configure\' in the object menu.';
export const urlForPdf = 'URL for PDF';
export const urlForPdfFailedToRender = 'PDF failed to render, please add a different PDF using \'Configure\' in the object menu.';
export const okButton = 'OK';
export const dropdownLabel = 'Optional Parameter';
export const dropdownInputText = 'Insert';
22 changes: 22 additions & 0 deletions Samples-Typescript/Dashboard/PdfViewer/PdfViewer.trex
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest manifest-version="0.1" xmlns="http://www.tableau.com/xml/extension_manifest">
<dashboard-extension id="com.tableau.extensions.samples.pdfViewer" extension-version="0.1.0">
<default-locale>en_US</default-locale>
<name resource-id="name"/>
<description>PDF Viewer</description>
<author name="tableau" email="[email protected]" organization="tableau" website="https://www.tableau.com"/>
<min-api-version>1.7</min-api-version>
<source-location>
<url>http://localhost:8765/Samples-Typescript/Dashboard/PdfViewer/pdfviewer.html</url>
</source-location>
<icon>iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAAB3RJTUUH4QgLDTYEcBRoeAAABp9JREFUeNrlm01sHEUWx//vVbs79gThjAd2iflIAkEcEARfEciBSYLEbbV8SJaDEpIAMQgkViuirA8IskKcdiEJX3G0C5dNpAVxQLIyiYw4YYIQBw4RBoMgBBIbCRtnOsx0vbcHd9sTZ3r8ge2p2bQ0B/+7unp+1dX/eX71ivL5TgAwAAQAxR/rsiYidvv2btq6ddcqVRwE8JCqgoigqgAAIvpKVbf29v51cHDwUxWRav2pWbdujcH04cUnPFc1EZGOjtv5hRdebv3tt9I+IupWVSaiGBxgJqhqlpnPj42NnchmsxpFUbX+mJORiE9E8eigorEzmohEHR23U1/fO63j47/+nYh2qqpJ4CcHgKEKMPOxIPBfef75PeUwDNPuoclozGxgXdMq4X/5ZWwfEe1Q1crZO/UKENGxIPCfKBbD4U2bNvo17qEeAHYJNA3+jjtuW2x4TgbAAmhyATRNy+XauK/vndaxsfEXFwk+0SIv/kNR/d2rOzwAc+TIu5ExnCeiR2vA9weB3zNXeM/zImutSUzQWfgYUpnNlapa6eCVP3slIjoShheGN2++Z1b4q6/+Q3T69Jng7Nlz0hAmODFxhq+4ol1S4AHAF5Fe3286u2PH1v5Dh9724nOX9Hf8+IfllpaWm8Mw3E2Eo4wGMMGVK1cLM6fBJ9q6cjna39W1c0tX14PW9/2q8JlMy01hGL4C4GlV/IsxHRnVHTRNi2G5BnyirbPWHty+vSe/YcOt5Pv+JfDFYrgfwBYAUNX1jGkTrDtoLU1E7CzwybEWwBsvvfSPe9evvxHGsKbAg4imwk1yBRTVTRCe5xlr7WzwibYGwOsHDry1O4qi/pnwAMDMEBEkL5YToGlaGP7E1tpaJlhNW2ut3e953rZiMfxnJXxlu4aIBJub/1gyxngiMlf4RLvRWnsQgF+tHRGp8yZYKAyUgiC4RVW75gmfaCtQ3UDLqnrUaRMsFAZKK1asuKVcLr+pqncuAD5NswAONzc3P+lsJDgD/q5Fhu/L5bJ/C8Nw1EkTXHr4tr3nzo2Obtx4NzlngssDPzKaz3d6xrBbJriM8E00mUayzvw7vEB4JaL3VfUDZjYARERgjGFrrY01FZGJtrZsoQI+ua9xIhJcKDwzHWU2T5dKpbP9/e/RNdes1h9++J7b26+TH388QwBw/fVrdGjoFJ869aXOgPcQJ0TQyPDd3Q+Pbtq0sQnTma0IF2e4Es2bCY965wQXA/67777nBX4XBlA/E6wzvEG8SFIXE3QAPtGWPyfoELyH+BXAZQq/vCboIPzymaCD8Mtngo7CJ9rSmqDj8Etrgg0Av3Qm2CDwS2OCDQK/NCbYQPCJtngm2IDwi2eCDQq/OCbYwPC/3wQbGD7dBEUkuuqqHHd0bLDbtj0iJ09+wu3t15XiFFM0mXY6zfff/+dSc3PDwieaoXy+M6mgrKzGWjU+Pp5nNq1xchEAWESsMcZYa4WZPVXtmseKjWvwF+cEK+vwkmosa22yNj8FlSxRz3Oh0kl4JCY4nyLEBWiuwk+a4PnzRXsZwk+ZIKlaam1dtSquvb1c4BONiJmzqvoiEe26zOA9ABER0X+I8CfVqcWE3wsPZnqf2ezq7n74Z5fhEQdCD4poNXgBcGEhAyKiH5TL5XOOwzMAZlWli+vtpwuPmflxAF/PdzYwM6dVajqkEQDLafBB4PdYa//d1OQ9parDc4WPD4n7dQG0lmbiJ6Uz4Z8oFsPhzZvv8ffs+Uu/MaYHwDdzhIeIYGLijFOFFymaXlQ9NbPeXkSijz/+xPT07DxGRI8T0bdzeRWMMbxy5WpxCDTdBIloSCR9s4G1loaGvsZzzz1zAsBjyUyoNRustXZGdUa9QWua4CPM/Krvp282KJVK3ueff6GHDx84bozZDWB4FhN0CbR2JLhly708PPytd+21qyNjTM2LiAiFwkDZ87xt1trXAATVZgMz77LWvpXPd85l20pdI0G21uratTfMCg8AhcJAOZNpucla+0AaPIBIRCYGB080hAl6ACAis15UreS8CrwFcLitLXu8UPgw2YvoAmjNSHDWJzUP+L5crm3vyMjoyMDAR67DT5ogZskJzhe+SilavUFrR4KYzglectGzzz4ZZTKZm4vF8NX/M/hEq7owwgCQybREvb37gmKxuBvAfcD0NpNKwwNwKJfLTpWfVoHnKl/CFU05fvoUN9D4ExWLIZ88+dkFIjoK4KsEXkSmBkBV/xsEwd6RkZ9H8/lOJiKN+7mkP1e1/wFtM6PWK/V/BwAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxNy0wOC0xMVQxMzo1NDowNC0wNDowMMrC9wEAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTctMDgtMTFUMTM6NTQ6MDQtMDQ6MDC7n0+9AAAAAElFTkSuQmCC</icon>
<context-menu>
<configure-context-menu-item />
</context-menu>
</dashboard-extension>
<resources>
<resource id="name">
<text locale="en_US">PDF Viewer</text>
</resource>
</resources>
</manifest>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import '@testing-library/jest-dom';
import { PdfViewerComponent } from '../pdfViewerComponent';

PdfViewerComponent.initialize = jest.fn();

import '../pdfViewer';

describe('PdfViewer', () => {
it('should call PdfViewerComponent.initialize' , async () => {
expect(PdfViewerComponent.initialize).toBeCalledTimes(1);
});
});
Loading

0 comments on commit 8004ee0

Please sign in to comment.