-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathfullpage.js.jquery.txt
86 lines (82 loc) · 6.74 KB
/
fullpage.js.jquery.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
┏━━━━━━━━━━━━━━━━━┓
┃ FULLPAGE.JS ┃
┗━━━━━━━━━━━━━━━━━┛
FULLPAGE.JS ==> #Create HTML slides, to navigate with keys, scrolling or swipes.
#Features: hard links, navigation menus, keyboard|swipe|scrolling, content fit, looping.
#Version 2.5.9
JQ.fullpage([OBJ]) #HTML structure:
# JQ
# .section[.active] (def .active: first one): vertical slide
# .slide: horizontal slide
#OBJ:
# (hard links)
# - anchors STR_ARR, where STR is "#ID", then using HTML attribute data-anchor="ID" on
# .section (must be unique among real IDs)
# Makes it possible to use as URL's hash (hard link)
# - animateAnchor BOOL (def: true): loading an anchor (hard link) animate from first slide
# to given slide, instead of loading it directly
# - recordHistory BOOL (def: same as autoScrolling): manipulates HTML5 history on slide
# change (so back button works)
# (navigation menu)
# - menu SELECTOR (def: null): add class "active" to SELECTOR child with
# data-menuanchor="ID" when "#ID" anchor is active. Used to highlight a navigation menu.
# SELECTOR should be outside JQ.
# - navigation BOOL (def: false): show navigation bars made up circles
# - navigationPosition "left|right": if navigation true
# - navigationTooltips STR_ARR (def: [], e.g. "firstSlide", "secondSlide"): tooltips, if
# navigation true
# - slidesNavigation BOOL (def: false): same as navigation BOOL, but for horizontal slides
# - slidesNavPosition "bottom|top": if slidesNavigation true
# (controls)
# - controlArrows BOOL (def: true): use HTML arrows for navigation
# - keyboardScrolling BOOL (def: true): use keyboard for navigation
# - touchSensitivity NUM (def: 5): swipe threshold, in percentage of window.width|height
# (content)
# - verticalCentered BOOL (def: true): vertically center .section|slide content
# - fitToSection BOOL (def: true): fit .section|slide content
# - scrollOverflow BOOL (def: false): if content too big, add scrollbar. Must load
# jQuery plugin slimscroll (before fullpage.js)
# - paddingTop|Bottom STR (def: 0): .section|slide CSS padding
# - resize BOOL (def: false): resize text on window resize
# - sectionsColor COLOR_ARR (def: "none"): .section|slide background-color
# - fixedElements SELECTOR (def: null): make those elements fixed on screen
# - normalScrollElements SELECTOR (def: null): make those elements scrollable without making
# slide change
# - normalScrollElementsTouchThreshold (def: 5)
# (transitions)
# - scrollingSpeed NUM (def: 700)
# - css3 BOOL (def: true): when supported, use CSS3 (faster)
# - easing[css3] STR (def: "easeInOutCubic|ease"): when [not] using css3 true
# (looping)
# - loopTop|Bottom|Horizontal BOOL (def: false|false|true): connect last slide to first one
# - continuousVertical BOOL (def: false): like loopTop + loopBottom
# (disable effect)
# - autoScrolling BOOL (def: true): if false, disable the main scrolling effect, putting
# back normal scrolling
# - responsive NUM (def: 0): put autoScrolling false when window width < NUMpx. Also
# adds class "fp-responsive" to JQ then.
# - scrollBar BOOL (def: false): do not hide scrollbar
# (other)
# - selection|slideSelector (def: ".selection|slide"): change the CSS class
# (callbacks)
# - afterRender(): when initial DOM manipulation done. Should be used if content requires
# DOM done.
# - afterLoad("ID", NUM): after a .section has been scrolled to
# - onLeave(NUM, NUM2, "up|down"): when leaving .section NUM for .section NUM2
# - afterSlideLoad("ID", NUM, "ID2", NUM2): same as afterLoad(), but for .slide.
# Two first arguments are .section, others are .slide
# - onSlideLeave("ID", NUM, NUM2, "right|left"): same as onLeave(), but for .slide.
# Two first arguments are .section, others are .slide
# - afterResize(): after sections resized because of window resize
$.fn.reBuild() #To call when updated DOM
$.fn.destroy(["all"]) #Destroy any event handler. If "all", also destroy any HTML modification.
$.fn.setAllowScrolling(BOOL[,STR])#STR is "DIRECTION[,...]" where DIRECTION is "all|up|down|left|right"
$.fn.fullpage.moveSectionUp|Down()#
$.fn.fullpage.
moveSlideRight|Left() #
$.fn.fullpage.moveTo(VAL[, VAL2]) #VAL is .section, VAL2 .slide. Can be "ID" or NUM.
$.fn.setAutoScrolling(BOOL) #
$.fn.setFitToSection(BOOL) #
$.fn.setKeyboardScrolling(BOOL) #
$.fn.setRecordHistory(BOOL) #
$.fn.setScrollingSpeed(NUM) #