Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve deepLink options docs #11075

Merged
merged 1 commit into from
Mar 24, 2018
Merged

docs: improve deepLink options docs #11075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions js/foundation.accordion.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,31 +294,29 @@ Accordion.defaults = {
*/
allowAllClosed: false,
/**
* Allows the window to scroll to content of pane specified by hash anchor
* Link the location hash to the open pane.
* Set the location hash when the opened pane changes, and open and scroll to the corresponding pane when the location changes.
* @option
* @type {boolean}
* @default false
*/
deepLink: false,

/**
* Adjust the deep link scroll to make sure the top of the accordion panel is visible
* If `deepLink` is enabled, adjust the deep link scroll to make sure the top of the accordion panel is visible
* @option
* @type {boolean}
* @default false
*/
deepLinkSmudge: false,

/**
* Animation time (ms) for the deep link adjustment
* If `deepLinkSmudge` is enabled, animation time (ms) for the deep link adjustment
* @option
* @type {number}
* @default 300
*/
deepLinkSmudgeDelay: 300,

/**
* Update the browser history with the open accordion
* If `deepLink` is enabled, update the browser history with the open accordion
* @option
* @type {boolean}
* @default false
Expand Down
5 changes: 3 additions & 2 deletions js/foundation.reveal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,14 +535,15 @@ Reveal.defaults = {
*/
resetOnClose: false,
/**
* Allows the modal to alter the url on open/close, and allows the use of the `back` button to close modals. ALSO, allows a modal to auto-maniacally open on page load IF the hash === the modal's user-set id.
* Link the location hash to the modal.
* Set the location hash when the modal is opened/closed, and open/close the modal when the location changes.
* @option
* @type {boolean}
* @default false
*/
deepLink: false,
/**
* Update the browser history with the open modal
* If `deepLink` is enabled, update the browser history with the open modal
* @option
* @default false
*/
Expand Down
11 changes: 6 additions & 5 deletions js/foundation.tabs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,39 +398,40 @@ class Tabs extends Plugin {

Tabs.defaults = {
/**
* Allows the window to scroll to content of pane specified by hash anchor
* Link the location hash to the active pane.
* Set the location hash when the active pane changes, and open the corresponding pane when the location changes.
* @option
* @type {boolean}
* @default false
*/
deepLink: false,

/**
* Adjust the deep link scroll to make sure the top of the tab panel is visible
* If `deepLink` is enabled, adjust the deep link scroll to make sure the top of the tab panel is visible
* @option
* @type {boolean}
* @default false
*/
deepLinkSmudge: false,

/**
* Animation time (ms) for the deep link adjustment
* If `deepLinkSmudge` is enabled, animation time (ms) for the deep link adjustment
* @option
* @type {number}
* @default 300
*/
deepLinkSmudgeDelay: 300,

/**
* Update the browser history with the open tab
* If `deepLink` is enabled, update the browser history with the open tab
* @option
* @type {boolean}
* @default false
*/
updateHistory: false,

/**
* Allows the window to scroll to content of active pane on load if set to true.
* Allows the window to scroll to content of active pane on load.
* Not recommended if more than one tab panel per page.
* @option
* @type {boolean}
Expand Down