vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #22329 from JodiWarren/master

Browse Source 
Add missing fullpage.js methods and update options to match version 2.9.5
This commit is contained in:
Paul van Brenk
2017-12-28 11:51:25 -08:00
committed by GitHub
parent 6475942629 760944edac
commit dfa1ada383
3 changed files with 330 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/fullpage.js/fullpage.js-tests.ts
+81 -14
View File
@@ -1,7 +1,7 @@
function test_public_methods() {
$(() => {
$(document).ready(function() {
$('#fullpage').fullpage({
// Navigation
//Navigation
menu: '#menu',
lockAnchors: false,
anchors:['firstPage', 'secondPage'],
@@ -9,10 +9,10 @@ function test_public_methods() {
navigationPosition: 'right',
navigationTooltips: ['firstSlide', 'secondSlide'],
showActiveTooltip: false,
slidesNavigation: true,
slidesNavigation: false,
slidesNavPosition: 'bottom',
// Scrolling
//Scrolling
css3: true,
scrollingSpeed: 700,
autoScrolling: true,
@@ -25,18 +25,27 @@ function test_public_methods() {
loopTop: false,
loopHorizontal: true,
continuousVertical: false,
continuousHorizontal: false,
scrollHorizontally: false,
interlockedSlides: false,
dragAndMove: false,
offsetSections: false,
resetSliders: false,
fadingEffect: false,
normalScrollElements: '#element1, .element2',
scrollOverflow: false,
scrollOverflowReset: false,
scrollOverflowOptions: null,
touchSensitivity: 15,
normalScrollElementTouchThreshold: 5,
bigSectionsDestination: null,
// Accessibility
//Accessibility
keyboardScrolling: true,
animateAnchor: true,
recordHistory: true,
// Design
//Design
controlArrows: true,
verticalCentered: true,
sectionsColor : ['#ccc', '#fff'],
@@ -45,18 +54,76 @@ function test_public_methods() {
fixedElements: '#header, .footer',
responsiveWidth: 0,
responsiveHeight: 0,
responsiveSlides: false,
parallax: false,
parallaxOptions: {type: 'reveal', percentage: 62, property: 'translate'},
// Custom selectors
//Custom selectors
sectionSelector: '.section',
slideSelector: '.slide',
// Events
onLeave: (index, nextIndex, direction) => {},
afterLoad: (anchorLink, index) => {},
afterRender: () => {},
afterResize: () => {},
afterSlideLoad: (anchorLink, index, slideAnchor, slideIndex) => {},
onSlideLeave: (anchorLink, index, slideIndex, direction, nextSlideIndex) => {}
lazyLoading: true,
//events
onLeave: function(index, nextIndex, direction){},
afterLoad: function(anchorLink, index){},
afterRender: function(){},
afterResize: function(){},
afterResponsive: function(isResponsive){},
afterSlideLoad: function(anchorLink, index, slideAnchor, slideIndex){},
onSlideLeave: function(anchorLink, index, slideIndex, direction, nextSlideIndex){}
});
});
$.fn.fullpage.moveSectionUp();
$.fn.fullpage.moveSectionDown();
$.fn.fullpage.moveTo('firstSlide', 2);
$.fn.fullpage.moveTo(3, 0);
$.fn.fullpage.moveTo(3);
$.fn.fullpage.silentMoveTo('firstSlide', 2);
$.fn.fullpage.moveSlideRight();
$.fn.fullpage.moveSlideLeft();
$.fn.fullpage.setAutoScrolling(false);
$.fn.fullpage.setFitToSection(false);
$.fn.fullpage.fitToSection();
$.fn.fullpage.setLockAnchors(false);
$.fn.fullpage.setAllowScrolling(false);
$.fn.fullpage.setAllowScrolling(false, 'down');
$.fn.fullpage.setAllowScrolling(false, 'down, right');
$.fn.fullpage.setKeyboardScrolling(false);
$.fn.fullpage.setKeyboardScrolling(false, 'down');
$.fn.fullpage.setKeyboardScrolling(false, 'down, right');
$.fn.fullpage.setRecordHistory(false);
$.fn.fullpage.setScrollingSpeed(700);
$.fn.fullpage.destroy();
$.fn.fullpage.destroy('all');
$.fn.fullpage.reBuild();
$.fn.fullpage.setResponsive(true);
$.fn.fullpage.responsiveSlides.toSections();
$.fn.fullpage.responsiveSlides.toSlides();
}
types/fullpage.js/index.d.ts
Vendored
+248 -3
View File
@@ -1,11 +1,13 @@
// Type definitions for fullpage.js v2.8.0
// Type definitions for fullpage.js v2.9.5
// Project: http://alvarotrigo.com/fullPage/
// Definitions by: Andrew Roberts <http://www.atroberts.org>
// Definitions by: Andrew Roberts <http://www.atroberts.org>, Jodi Warren <https://github.com/jodiwarren>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
/// <reference types="jquery" />
import htmlString = JQuery.htmlString;
interface FullPageJsOptions {
/**
* (default false) A selector can be used to specify the menu to link with the sections. This way the scrolling of the sections will activate the corresponding element in the menu using the class active. This won't generate a menu but will just add the active class to the element in the given menu with the corresponding anchor links. In order to link the elements of the menu with the sections, an HTML 5 data-tag (data-menuanchor) will be needed to use with the same anchor links as used within the sections.
@@ -114,6 +116,47 @@ interface FullPageJsOptions {
*/
continuousVertical?: boolean;
/**
* (default false) Extension of fullpage.js. Defines whether sliding right in the last slide should slide right to the first one or not, and if scrolling left in the first slide should slide left to the last one or not. Not compatible with loopHorizontal. Requires fullpage.js >= 2.8.3.
*/
continuousHorizontal?: boolean;
/**
* (default false) Extension of fullpage.js. Defines whether to slide horizontally within sliders by using the mouse wheel or trackpad. Ideal for story telling. Requires fullpage.js >= 2.8.3.
*/
scrollHorizontally?: boolean;
/**
* (default false) Extension of fullpage.js. Determines whether moving one horizontal slider will force the sliding of sliders in other section in the same direction. Possible values are true, false or an array with the interlocked sections. For example [1,3,5] starting by 1. Requires fullpage.js >= 2.8.3.
*/
interlockedSlides?: boolean | number[];
/**
* Enables or disables the dragging and flicking of sections and slides by using mouse or fingers. Requires fullpage.js >= 2.8.9. Possible values are:
* true: enables the feature.
* false: disables the feature.
* vertical: enables the feature only vertically.
* horizontal: enables the feature only horizontally.
* fingersonly: enables the feature for touch devices only.
* mouseonly: enables the feature for desktop devices only (mouse and trackpad).
*/
dragAndMove?: boolean | 'vertical' | 'horizontal' | 'fingersonly' | 'mouseonly';
/**
* (default false)Extension of fullpage.js. Provides a way to use non full screen sections based on percentage. Ideal to show visitors there's more content in the site by showing part of the next or previous section. Requires fullPage.js >= 2.8.8 To define the percentage of each section the attribute data-percentage must be used. The centering of the section in the viewport can be determined by using a boolean value in the attribute data-centered (default to true if not specified). For example:
*/
offsetSections?: boolean;
/**
* (default false). Extension of fullpage.js. Defines whether or not to reset every slider after leaving its section. Requires fullpage.js >= 2.8.3.
*/
resetSliders?: boolean;
/**
* Defines whether to use a fading effect or not instead of the default scrolling one. Possible values are true, false, sections, slides. It can therefore be applied just vertically or horizontally, or to both at the time. Requires fullpage.js >= 2.8.6.
*/
fadingEffect?: boolean | 'sections' | 'slides';
/**
* (default null) If you want to avoid the auto scroll when scrolling over some elements, this is the option you need to use. (useful for maps, scrolling divs etc.) It requires a string with the jQuery selectors for those elements. (For example: normalScrollElements: '#element1, .element2')
*/
@@ -129,6 +172,11 @@ interface FullPageJsOptions {
*/
scrollOverflowOptions?: any;
/**
* When set to true it scrolls up the content of the section/slide with scroll bar when leaving to another vertical section. This way the section/slide will always show the start of its content even when scrolling from a section under it
*/
scrollOverflowReset?: boolean;
/**
* (default 5) Defines a percentage of the browsers window width/height, and how far a swipe must measure for navigating to the next section / slide
*/
@@ -139,6 +187,11 @@ interface FullPageJsOptions {
*/
normalScrollElementTouchThreshold?: number;
/**
* Defines how to scroll to a section which size is bigger than the viewport. By default fullPage.js scrolls to the top if you come from a section above the destination one and to the bottom if you come from a section below the destination one.
*/
bigSectionsDestination?: 'top' | 'bottom' | null;
// Accessibility
/**
@@ -200,6 +253,30 @@ interface FullPageJsOptions {
*/
responsiveHeight?: number;
/**
* When set to true slides will be turned into vertical sections when responsive mode is fired. (by using the responsiveWidth or responsiveHeight options detailed above). Requires fullpage.js >= 2.8.5.
*/
responsiveSlides?: boolean;
/**
* When set to true slides will be turned into vertical sections when responsive mode is fired. (by using the responsiveWidth or responsiveHeight options detailed above). Requires fullpage.js >= 2.8.5.
*/
parallax?: boolean;
/**
* Allows to configure the parameters for the parallax backgrounds effect when using the option parallax:true.
*/
parallaxOptions?: {
type?: 'cover' | 'reveal',
percentage?: number,
property?: string,
};
/**
* Lazy loading is active by default which means it will lazy load any media element containing the attribute data-src as detailed in the Lazy Loading docs . If you want to use any other lazy loading library you can disable this fullpage.js feature.
*/
lazyLoading?: boolean;
// Custom selectors
/**
@@ -238,6 +315,12 @@ interface FullPageJsOptions {
*/
afterResize?: () => void;
/**
* This callback is fired after fullpage.js changes from normal to responsive mode or from responsive mode to normal mode.
* @param {boolean} isResponsive boolean that determines if it enters into responsive mode (true) or goes back to normal mode (false)
*/
afterResponsive?: (isResponsive: boolean) => void;
/**
* Callback fired once the slide of a section have been loaded, after the scrolling has ended.
*
@@ -263,6 +346,168 @@ interface FullPageJsOptions {
onSlideLeave?: (anchorLink: string, index: number, slideIndex: number, direction: string, nextSlideIndex: number) => void;
}
interface FullPageJSGlobalOptions {
options: FullPageJsOptions;
}
interface FullPageJsMethods {
(options?: FullPageJsOptions): any;
/**
* Sets the scrolling configuration in real time.
* Defines the way the page scrolling behaves.
* If it is set to true, it will use the "automatic" scrolling,
* otherwise, it will use the "manual" or "normal" scrolling of the site.
*/
setAutoScrolling(active: boolean): void;
/**
* Defines whether to record the history for each hash change in the URL.
*/
setRecordHistory(active: boolean): void;
/**
* Defines the scrolling speed in milliseconds.
*/
setScrollingSpeed(speed: number): void;
/**
* Sets the value for the option fitToSection
* determining whether to fit the section in the screen or not.
*/
setFitToSection(active: boolean): void;
/**
* Adds or remove the possibility of scrolling through sections
* by using the mouse wheel or the trackpad.
*/
setLockAnchors(active: boolean): void;
/**
* Adds or remove the possibility of scrolling through sections
* by using the mouse wheel or the trackpad.
*/
setMouseWheelScrolling(active: boolean): void;
/**
* Adds or remove the possibility of scrolling through sections
* by using the mouse wheel/trackpad or touch gestures.
* Optionally a second parameter can be used to specify the direction
* for which the action will be applied.
*/
setAllowScrolling(active: boolean, directions?: string): void;
/**
* Adds or remove the possibility of scrolling through sections
* by using the keyboard arrow keys
*/
setKeyboardScrolling(active: boolean, directions?: string): void;
/**
* Scrolls one section up
*/
moveSectionUp(): void;
/**
* Scrolls one section down
*/
moveSectionDown(): void;
/**
* Moves the page to the given section and slide with no animation.
* Anchors or index positions can be used as params.
*/
silentMoveTo(sectionAnchor: number | string, slideAnchor?: number | string): void;
/**
* Scrolls the page to the given section and slide.
* The first slide, the visible one by default, will have index 0.
*/
moveTo(sectionAnchor: number | string, slideAnchor?: number | string): void;
/**
* Slides right the slider of the active section.
* Optional `section` param.
*/
moveSlideRight(section?: number | string): void;
/**
* Slides left the slider of the active section.
* Optional `section` param.
*/
moveSlideLeft(section?: number | string): void;
/**
* When resizing is finished, we adjust the slides sizes and positions
*/
reBuild(): void;
/**
* Sets the responsive mode of the page.
* When set to true the autoScrolling will be turned off
* and the result will be exactly the same one as when
* the responsiveWidth or responsiveHeight options
* get fired.
*/
setResponsive(active: boolean): void;
/**
* Sets the value for the option fitToSection
* determining whether to fit the section
* in the screen or not.
*/
setFitToSection(active?: boolean): void;
/**
* Scrolls to the nearest active section fitting it in the viewport.
*/
fitToSection(): void;
/**
* Adds or remove the possibility of scrolling through sections/slides
* by using the mouse wheel/trackpad or touch gestures
* (which is active by default).
*
* Note this won't disable the keyboard scrolling. You would need to
* use setKeyboardScrolling for it.
*/
setAllowScrolling(allow: boolean, direction?: string): void;
/**
* Destroys the plugin events and optionally its HTML markup and styles.
* Ideal to use when using AJAX to load content.
*
* If 'all' is passed, the HTML markup
* and styles used by fullpage.js will be removed. This way the
* original HTML markup, the one used before any plugin
* modification is made, will be maintained.
*
* @param {"all" | undefined} type
*/
destroy(type?: 'all'): void;
responsiveSlides: {
/**
* Extension of fullpage.js. Requires fullpage.js >= 2.8.5.
* Turns horizontal slides into vertical sections.
*/
toSections(): void;
/**
* Extension of fullpage.js. Requires fullpage.js >= 2.8.5.
* Turns back the original slides (now converted into
* vertical sections) into horizontal slides again.
*/
toSlides(): void;
}
}
interface FullPageJs extends FullPageJSGlobalOptions, FullPageJsMethods {}
interface JQueryStatic {
fullpage: FullPageJsMethods;
}
interface JQuery {
fullpage(options?: FullPageJsOptions): JQuery;
fullpage: FullPageJs;
}
types/fullpage.js/tsconfig.json
+1 -1
View File
@@ -21,4 +21,4 @@
"index.d.ts",
"fullpage.js-tests.ts"
]
}
}