From dd1dcf68bf0448eeae485f9449d23016f5aef705 Mon Sep 17 00:00:00 2001 From: AntonDemarczyk Date: Mon, 29 Apr 2019 19:37:41 +0200 Subject: [PATCH] Added readmore-js 3.0.0-Beta support (#35079) --- types/readmore-js/index.d.ts | 30 ++++++++++++++++++++++++++ types/readmore-js/readmore-js-tests.ts | 28 ++++++++++++++++++++++++ types/readmore-js/tsconfig.json | 24 +++++++++++++++++++++ types/readmore-js/tslint.json | 1 + 4 files changed, 83 insertions(+) create mode 100644 types/readmore-js/index.d.ts create mode 100644 types/readmore-js/readmore-js-tests.ts create mode 100644 types/readmore-js/tsconfig.json create mode 100644 types/readmore-js/tslint.json diff --git a/types/readmore-js/index.d.ts b/types/readmore-js/index.d.ts new file mode 100644 index 0000000000..d609a10c9b --- /dev/null +++ b/types/readmore-js/index.d.ts @@ -0,0 +1,30 @@ +// Type definitions for readmore-js 3.0 +// Project: https://github.com/jedfoster/Readmore.js +// Definitions by: AntonDemarczyk +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare class Readmore { + constructor(element: string | Element | NodeList, options?: Readmore.Options); + + toggle(element: null | string | Element | NodeList): void; + + destroy(): void; +} + +declare namespace Readmore { + interface Options { + speed?: number; // 100 in milliseconds + collapsedHeight?: number; // 200 in pixels + heightMargin?: number; // 16 in pixels, avoids collapsing blocks that are only slightly larger than collapsedHeight + moreLink?: ((element: Element) => string) | string; // HTML string for the "more" toggle link; also accepts a callback function that returns an HTML string + lessLink?: ((element: Element) => string) | string; // HTML string for the "less" toggle link; also accepts a callback function that returns an HTML string + embedCSS?: boolean; // insert required CSS dynamically, set this to false if you include the necessary CSS in a stylesheet + blockCSS?: string; // sets the styling of the blocks, ignored if embedCSS is false + startOpen?: boolean; + sourceOrder?: 'after' | 'before'; + beforeToggle?: (trigger: Element, element: Element, expanded: boolean) => void; // called once per block during initilization after Readmore.js has processed the block + afterToggle?: (trigger: Element, element: Element, expanded: boolean) => void; // called after a more or less link is clicked, but before the block is collapsed or expanded + blockProcessed?: (element: Element, collapsable: boolean) => void; // called after the block is collapsed or expanded + } +} +export = Readmore; diff --git a/types/readmore-js/readmore-js-tests.ts b/types/readmore-js/readmore-js-tests.ts new file mode 100644 index 0000000000..16347e31b2 --- /dev/null +++ b/types/readmore-js/readmore-js-tests.ts @@ -0,0 +1,28 @@ +import * as Readmore from 'readmore-js'; + +const options: Readmore.Options = { + speed: 100, + collapsedHeight: 200, + heightMargin: 16, + moreLink: 'Read more', + lessLink: () => 'Close', + embedCSS: true, + blockCSS: 'display: block; width: 100%;', + startOpen: false, + sourceOrder: 'after', + beforeToggle: (trigger: Element, element: Element, expanded: boolean) => { + console.log(trigger, element, element); + }, + afterToggle: (trigger: Element, element: Element, expanded: boolean) => { + console.log(trigger, element, element); + }, + blockProcessed: (element: Element, collapsable: boolean) => { + console.log(element, element); + } +}; + +new Readmore('.selector', options); + +const outer = new Readmore('.outer'); +outer.toggle('.inner'); +outer.destroy(); diff --git a/types/readmore-js/tsconfig.json b/types/readmore-js/tsconfig.json new file mode 100644 index 0000000000..927eeeb88e --- /dev/null +++ b/types/readmore-js/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "readmore-js-tests.ts" + ] +} diff --git a/types/readmore-js/tslint.json b/types/readmore-js/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/readmore-js/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }