DevExtreme v23.2 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Scroll View

Documentation

The ScrollView is a UI component that enables a user to scroll its content. This demo shows how to display the scrollbar within a container and how to update the ScrollView content.

Backend API
<template> <div> <div id="scrollview-demo"> <DxScrollView id="scrollview" ref="scrollViewWidget" :scroll-by-content="scrollByContent" :scroll-by-thumb="scrollByThumb" :show-scrollbar="showScrollbar" :bounce-enabled="pullDown" reach-bottom-text="Updating..." @pull-down="updateTopContent" @reach-bottom="updateBottomContent" > <div class="text-content" v-html="content" /> </DxScrollView> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Show scrollbar: </span> <DxSelectBox id="show-scrollbar-mode" :items="showScrollbarModes" :input-attr="{ 'aria-label': 'Show Scrollbar Mode' }" v-model:value="showScrollbar" value-expr="value" display-expr="text" /> </div> <div class="option"> <DxCheckBox id="use-reach-bottom" :value="true" text="Update content on the ReachBottom event" @value-changed="onValueChanged" /> </div> <div class="option"> <DxCheckBox id="use-pull-down-bottom" v-model:value="pullDown" text="Update content on the PullDown event" /> </div> <div class="option"> <DxCheckBox v-model:value="scrollByContent" text="Scroll by content" /> </div> <div class="option"> <DxCheckBox v-model:value="scrollByThumb" text="Scroll by thumb" /> </div> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import { DxScrollView } from 'devextreme-vue/scroll-view'; import { DxSelectBox } from 'devextreme-vue/select-box'; import { DxCheckBox } from 'devextreme-vue/check-box'; import { longText } from './data.ts'; const content = ref(longText); const pullDown = ref(false); const showScrollbarModes = ref([ { text: 'On Scroll', value: 'onScroll', }, { text: 'On Hover', value: 'onHover', }, { text: 'Always', value: 'always', }, { text: 'Never', value: 'never', }, ]); const showScrollbar = ref('onScroll'); const scrollByContent = ref(true); const scrollByThumb = ref(true); const scrollViewWidget = ref(); let updateContentTimer; function updateContent(args, eventName) { const updateContentText = `<br /><div>Content has been updated on the ${ eventName } event.</div><br />`; if (updateContentTimer) clearTimeout(updateContentTimer); updateContentTimer = setTimeout(() => { content.value = eventName === 'PullDown' ? updateContentText + content.value : content.value + updateContentText; args.component.release(); }, 500); } function updateBottomContent(e) { updateContent(e, 'ReachBottom'); } function updateTopContent(e) { updateContent(e, 'PullDown'); } function onValueChanged(args) { scrollViewWidget.value.instance.option( 'onReachBottom', args.value ? updateBottomContent : null, ); } </script> <style scoped> #scrollview-demo { min-height: 550px; } #scrollview { height: auto; position: absolute; top: 0; bottom: 300px; padding: 20px; } .options { padding: 20px; background-color: rgba(191, 191, 191, 0.15); position: absolute; bottom: 0; left: 0; right: 0; } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; } .option > span { position: relative; top: 2px; margin-right: 10px; } .text-content { white-space: pre-wrap; } .option > .dx-selectbox { display: inline-block; vertical-align: middle; max-width: 340px; width: 100%; } </style>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@23.2.5/cjs', 'devextreme-vue': 'npm:devextreme-vue@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'devextreme-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.12/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
let text = ''; for (let i = 0; i < 10; i += 1) { text += 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\n'; } export const longText = text;
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!DOCTYPE html> <html> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.2.5/css/dx.light.css" /> <script src="https://unpkg.com/typescript@4.2.4/lib/typescript.js"></script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.3.4/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>