TiddlyWiki5/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-scroll.tid

caption: tm-scroll
created: 20160425000906330
modified: 20201014152456174
tags: Messages
title: WidgetMessage: tm-scroll
type: text/vnd.tiddlywiki

The `tm-scroll` message causes the surrounding scrollable container to scroll to the specified DOM node into view. The `tm-scroll` is handled in various places in the core itself, but can also be handled by a [[ScrollableWidget]].

|!Name |!Description |
|target |Target DOM node the scrollable container should scroll to (note that this parameter can only be set via JavaScript code) |
|selector |<<.from-version "5.1.23">> Optional string [[CSS selector|https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors]] as an alternate means of identifying the target DOM node |
|animationDuration |<<.from-version "5.2.2">> Optional number specifying the animation duration in milliseconds for the scrolling. Defaults to the [[global animation duration|$:/config/AnimationDuration]]. |

<<.tip "Set `animationDuration` to `0` to scroll without animation">>
Add missing widget message documentation (#2399) * Add documentation to various widget messages. The following widget messages now have documentation: * tm-edit-bitmap-operation * tm-edit-text-operation * tm-fold-all-tiddlers * tm-fold-other-tiddlers * tm-fold-tiddler * tm-unfold-all-tiddlers * tm-load-plugin-from-library * tm-load-plugin-library * tm-open-window * tm-scroll * Fixed alignment error. 2016-04-25 07:28:42 +00:00			`caption: tm-scroll`
			`created: 20160425000906330`
Extend tm-scroll to accept CSS selector to identify the target 2020-10-14 14:59:27 +00:00			`modified: 20201014152456174`
Add missing widget message documentation (#2399) * Add documentation to various widget messages. The following widget messages now have documentation: * tm-edit-bitmap-operation * tm-edit-text-operation * tm-fold-all-tiddlers * tm-fold-other-tiddlers * tm-fold-tiddler * tm-unfold-all-tiddlers * tm-load-plugin-from-library * tm-load-plugin-library * tm-open-window * tm-scroll * Fixed alignment error. 2016-04-25 07:28:42 +00:00			`tags: Messages`
			`title: WidgetMessage: tm-scroll`
			`type: text/vnd.tiddlywiki`

Update document in tiddlywiki.com edition * Add string '.htm' to 'Saving with TiddlyIE' * Change external links to match locale with wiki language * Add instructions for use to 'Saving on Android' * Change string in 'task' * Change instructions for use in 'Saving on iPad/iPhone' * Add newline to 'TiddlyDesktop Releases' * Remove caption from 'Serving TW5 from Android' * Change link to external in tiddlers which tagged 'Editions' * Remove string 'index.html' from 'Some of the things you can do with TiddlyWiki' * Change link 'TiddlyWiki Groups' to 'Forums' in tiddlers which tagged 'Community' * Remove CamelCase link 'TiddlyWiki' from tiddlers tagged 'Community' * Change string 'done' to 'Upgrade' in 'UpgradeMechanism' * Change buttons to images in 'How to export tiddlers' * Add images about buttons to tiddlers * Add quotation mark to text 'edit' in 'Signing the Contributor License Agreement' * Rename 'UsingSVG' to 'Using SVG' * Change link 'TypedBlockWikiText' to 'Typed Blocks in WikiText' in 'Using SVG' * Add tiddler 'Using Stamp' * Add 'rel="noopener noreferrer"' to external links * Add description about 'rel="noreferrer"' to 'HTML in WikiText' * Add link of prerelease version about translators edition, and how to translate on Node.js, in 'Translate TiddlyWiki into your language' * Change string 'dropdown' to 'tab' in 'Installing a plugin from the plugin library' * Add download button to 'Empty Edition' 2016-05-03 02:28:06 +00:00			The `tm-scroll` message causes the surrounding scrollable container to scroll to the specified DOM node into view. The `tm-scroll` is handled in various places in the core itself, but can also be handled by a [[ScrollableWidget]].
Add missing widget message documentation (#2399) * Add documentation to various widget messages. The following widget messages now have documentation: * tm-edit-bitmap-operation * tm-edit-text-operation * tm-fold-all-tiddlers * tm-fold-other-tiddlers * tm-fold-tiddler * tm-unfold-all-tiddlers * tm-load-plugin-from-library * tm-load-plugin-library * tm-open-window * tm-scroll * Fixed alignment error. 2016-04-25 07:28:42 +00:00
			`\|!Name \|!Description \|`
Extend tm-scroll to accept CSS selector to identify the target 2020-10-14 14:59:27 +00:00			`\|target \|Target DOM node the scrollable container should scroll to (note that this parameter can only be set via JavaScript code) \|`
			`\|selector \|<<.from-version "5.1.23">> Optional string [[CSS selector\|https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors]] as an alternate means of identifying the target DOM node \|`
Add support to tm-scroll message for scrolling without animating (#6410) * feat: add support for animationDuration attribute of paramObject for tm-scroll message * docs: added docs for animationDuration attribute of tm-scroll message * fix: use .utils.hop instead of Object.hasOwnProperty() * fix: do not check if object before calling utils.hop() * fix: syntax 2022-01-24 09:44:04 +00:00			`\|animationDuration \|<<.from-version "5.2.2">> Optional number specifying the animation duration in milliseconds for the scrolling. Defaults to the [[global animation duration\|$:/config/AnimationDuration]]. \|`

			<<.tip "Set `animationDuration` to `0` to scroll without animation">>