flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

🤖 Merge PR #45692 Update @typeform/embed to v0.22.0 by @gcangussu

Browse Source
This commit is contained in:
Gabriel Cangussu 2020-06-24 19:33:09 -03:00 committed by GitHub
parent 50b4c927de
commit 43fb3ee9a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
types/typeform__embed/index.d.ts vendored
View File

@ -1,4 +1,4 @@
// Type definitions for typeform__embed 0.20
// Type definitions for typeform__embed 0.22
// Project: https://github.com/Typeform/embed
// Definitions by: Florian Merz <https://github.com/florianmrz>
// Gabriel Cangussu <https://github.com/gcangussu>
@ -15,13 +15,39 @@ export interface WidgetOptions {
disableTracking?: boolean;
}
export interface PopupOptions {
mode?: 'popup' | 'drawer_left' | 'drawer_right';
mode?: 'popup' | 'drawer_left' | 'drawer_right' | 'popover';
/**
* @deprecated Use `open: 'load'` instead
*/
autoOpen?: boolean;
/**
* Launch based on behavioral triggers
*/
open?: 'exit' | 'load' | 'scroll' | 'time';
/**
* Configuration for behavioral triggers. Based on open:
* - `exit`: exit threshold in pixels
* - `scroll`: % of page scrolled
* - `time`: time in milliseconds
*/
openValue?: number;
autoClose?: number;
hideScrollbars?: boolean;
hideFooter?: boolean;
hideHeaders?: boolean;
/**
* @deprecated Use `width` instead
*/
drawerWidth?: number;
/**
* Specify the width of the drawer or popup (only applies if using mode
* "drawer_left" or "drawer_right" or "popover")
*/
width?: number;
/**
* Specify the height of the popup (only applies if using mode "popover")
*/
height?: number;
onSubmit?: (event: OnSubmitEvent) => void;
onReady?: () => void;
onClose?: () => void;
@ -37,5 +63,5 @@ export interface PopupInstance {
close: () => void;
}
export function makeWidget(element: HTMLElement, url: string, options: WidgetOptions): void;
export function makePopup(url: string, options: PopupOptions): PopupInstance;
export function makeWidget(element: HTMLElement, url: string, options?: WidgetOptions): void;
export function makePopup(url: string, options?: PopupOptions): PopupInstance;

10
types/typeform__embed/typeform__embed-tests.ts
View File

@ -2,6 +2,9 @@ import * as typeformEmbed from '@typeform/embed';
const stubContainerEl = document.createElement('div');
// optional options param
typeformEmbed.makeWidget(stubContainerEl, 'https://admin.typeform.com/to/PlBzgL');
typeformEmbed.makeWidget(stubContainerEl, 'https://admin.typeform.com/to/PlBzgL', {
opacity: 55,
buttonText: 'Answer this!',
@ -16,14 +19,21 @@ typeformEmbed.makeWidget(stubContainerEl, 'https://admin.typeform.com/to/PlBzgL'
onReady: () => {},
});
// optional options param
typeformEmbed.makePopup('https://admin.typeform.com/to/PlBzgL');
typeformEmbed.makePopup('https://admin.typeform.com/to/PlBzgL', {
mode: 'drawer_left',
autoOpen: true,
open: 'scroll',
openValue: 0,
autoClose: 3,
hideScrollbars: true,
container: stubContainerEl,
disableTracking: false,
drawerWidth: 500,
width: 500,
height: 600,
hideFooter: true,
hideHeaders: true,
onSubmit: ({ response_id }) => {