csswg-drafts/css-snappoints/Overview.src.html at abeb2269cae303ccf1bf6c9608377a056003a3d0 · w3c/csswg-drafts · GitHub

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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<h1>CSS Scroll Snap Points Module Level 1</h1>
<pre class='metadata'>
Group: csswg
Shortname: css-snappoints
Level: 1
Status: ED
ED: http://dev.w3.org/csswg/css-snappoints/
Editor: Matt Rakow, Microsoft
Editor: Jacob Rossi, Microsoft
Abstract: This module contains features to control panning and scrolling behavior with “snap points”.
!Issue Tracking: <a href="http://wiki.csswg.org/spec/css-snappoints">http://wiki.csswg.org/spec/css-snappoints</a>
</pre>

<h2 id="intro">
Introduction</h2>

	<em>This section is not normative.</em>

	Popular UX paradigms for scrollable content frequently employ pagination of content, or sectioning into logical divisions. This is especially true for touch interactions where it is quicker and easier for users to quickly pan through a flatly-arranged breadth of content rather than delving into a heirarchical structure through tap navigation. For example, it is easier for a user view many photos in a photo album by panning through a photo slideshow view rather than tapping on individual photos in an album.

	However, given the imprecise nature of scrolling inputs like touch panning and mousewheel scrolling, it is difficult for web developers to guarantee a well-controlled scrolling experience, in particular creating the effect of pagination. For instance, it is easy for a user to land at an awkward scroll offset which leaves a page partially on-screen when panning.

	To this end, we introduce scroll snap points which enforce the scroll offsets that a scroll container may end at after a scrolling operation has completed.

<h3 id="placement">
Module interactions</h3>

	This module extends the scrolling user interface features defined in [[!CSS21]] section 11.1.

	None of the properties in this module apply to the ''::first-line'' and ''::first-letter'' pseudo-elements.

<h3 id="values">
Values</h3>

	This specification follows the
	<a href="http://www.w3.org/TR/CSS21/about.html#property-defs">CSS property
	definition conventions</a> from [[!CSS21]]. Value types not defined in
	this specification are defined in CSS Level 2 Revision 1 [[!CSS21]].
	Other CSS modules may expand the definitions of these value types: for
	example [[CSS3VAL]], when combined with this module, expands the
	definition of the <var>&lt;length></var> value type as used in this specification.

	In addition to the property-specific values listed in their definitions,
	all properties defined in this specification also accept the
	<a href="http://www.w3.org/TR/CSS21/cascade.html#value-def-inherit">inherit</a>
	keyword as their property value. For readability it has not been repeated
	explicitly.

<h2 id="examples">
Examples</h2>

<h3>
Example 1: Using snap points with snapInterval</h3>

  <div class=example>
  <p>In this example, a series of images arranged in a <span>scroller</span> are used to build a photo gallery.
      The <span>scroller</span> is sized to the same size of the images contained therein. Using mandatory snap
      points, scrolling will always complete with a snap point aligned to the edge of the <span>scroller</span>.
      By aligning a snap point at the edge of each image, this creates a photo viewer were users can scroll
      through the images one at a time.</p>
  <pre>img {
    width:500px;
}
.photoGallery {
    width: 500px;
    overflow-x: auto;
    overflow-y: hidden;
    white-space: nowrap;
    scroll-snap-points-x: snapInterval(0px,100%); /* Sets up points to which scrolling will snap along x-axis */
    scroll-snap-type: mandatory; /* Requires that scrolling always end at a snap point when the operation completes (hard snap) */
}</pre>
<code class="html">&lt;div class=&quot;photoGallery&quot;&gt;
    &lt;img src=&quot;img1.jpg&quot;&gt;&lt;img src=&quot;img2.jpg&quot;&gt;&lt;img src=&quot;img3.jpg&quot;&gt;&lt;img src=&quot;img4.jpg&quot;&gt;&lt;img src=&quot;img5.jpg&quot;&gt;
&lt;/div&gt;</code>

<div class=figure>
  <p><img src="interval_snap_points.png"
  alt="The layout of the scroller's contents in the example. Snap points are set along the x-axis, starting at 0px and repeating at intervals of 100% of the scroller's width.">

  <p class=caption>The layout of the scroller's contents in the example. Snap points are set along the x-axis, starting at 0px and repeating at intervals
  	of 100% of the scroller's width.
  </div>
  </div>

<h3>Example 2: Using snap points with centered element snapping</h3>
  <div class=example>
  <p>This example also builds a photo gallery as in example 1.  However, in this example the <span>scroller</span>
     is larger than the photos contained within (such that multiple images may be seen simultaneously), and the image
     sizes vary (such that a snapInterval would not be effective).  Using mandatory element-based snap points, scrolling
     will always complete with an image centered in the <span>scroller</span>.
     </p>
  <pre>img {
    scroll-snap-coordinate-x: 50% /* Defines the center of each photo as the coordinate that should be used for snapping */
}
.photoGallery {
    width: 500px;
    overflow-x: auto;
    overflow-y: hidden;
    white-space: nowrap;
    scroll-snap-points-x: elements; /* Denotes that snap points will be defined by the elements contained within. */
    scroll-snap-axis-x: 50% /* Specifies that each element's snap coordinate should align with the center of the scroller */
    scroll-snap-type: mandatory; /* Requires that scrolling always end at a snap point when the operation completes (hard snap) */
}</pre>
<code class="html">&lt;div class=&quot;photoGallery&quot
8000
;&gt;
    &lt;img src=&quot;img1.jpg&quot;&gt;&lt;img src=&quot;img2.jpg&quot;&gt;&lt;img src=&quot;img3.jpg&quot;&gt;&lt;img src=&quot;img4.jpg&quot;&gt;&lt;img src=&quot;img5.jpg&quot;&gt;
&lt;/div&gt;</code>

<div class=figure>
  <p><img src="element_snap_points.png"
  alt="The layout of the scroller's contents in the example. The snap-axis is horizontally centered within the scroller (represented by a red line), and each element has its snap coordinate horizontally centered within the element (represented by dashed yellow lines).">

  <p class=caption>The layout of the scroller's contents in the example. The snap-axis is horizontally centered within the
  	scroller (represented by a red line), and each element has its snap coordinate horizontally centered within the element
  	(represented by dashed yellow lines).
  </div>
  </div>

<h2 id="definitions">
Definitions</h2>

	<dl>
		<dt><dfn export>scroll container</dfn>
		<dd>
			An element which provides a scrolling user interface as described in [[!CSS21]], particularly in the section on overflow.
	</dl>

<h2 id="scroll-snap-type">
Scroll Snap Types: the 'scroll-snap-type' property</h2>

	The ''scroll-snap-type'' property is used to define the physics characteristics of panning and scrolling, if any. It defines how and when snap points are enforced on the scroll container it is applied to.

	<pre class='propdef'>
	Name: scroll-snap-type
	Value: none | mandatory | proximity
	Initial: none
	Applies to: <a>scroll containers</a>
	Inherited: no
	Percentages: n/a
	Media: interactive
	Computed value: specified value
	Animatable: no
	</pre>

	<dl dfn-type="value" dfn-for="scroll-snap-type">
		<dt><dfn>none</dfn>
		<dd>
			This <a>scroll container</a> must ignore snap points, if any, when scrolled.

		<dt><dfn>mandatory</dfn>
		<dd>
			This <a>scroll container</a> must come to rest on a snap point at the termination of a scroll, if possible.

		<dt><dfn>proximity</dfn>
		<dd>
			This <a>scroll container</a> may come to rest on a snap point at the termination of a scroll at the discretion of the UA given the parameters of the scroll.
	</dl>

<h2 id="scroll-snap-points">
Scroll Snap Points: the 'scroll-snap-points-x' and 'scroll-snap-points-y properties</h2>

<p>The 'scroll-snap-points-x' and 'scroll-snap-points-y' properties are used to define the positioning of snap points within the content of the <span>scroller</span> they are applied to, or to declare the scroller as snapping to elements.</p>
  <table class=propdef>
    <tr>
      <th>Name:
      <td><dfn>scroll-snap-points-x</dfn>, <dfn>scroll-snap-points-y</dfn>
    <tr>
      <th><a href="#values">Value</a>:
      <td>snapInterval(&lt;length&gt;,&lt;length&gt;) | snapList(&lt;length&gt;[,&lt;length&gt;]*) | elements
    <tr>
      <th>Initial:
      <td>snapInterval(0px, 100%)
    <tr>
      <th>Applies to:
      <td>block-level <span class="index-def">scrollers</span>
    <tr>
      <th>Inherited:
      <td>no
    <tr>
      <th>Percentages:
      <td>Refer to the padding-box of the <span>scroller</span>
    <tr>
      <th>Media:
      <td>interactive
    <tr>
      <th>Computed&nbsp;value:
      <td>specified value
    <tr>
      <th>Animatable:
      <td>no
    <tr>
      <th>Canonical order:
      <td><abbr title="follows order of property value definition">per grammar</abbr>
  </table>

  <dl>
    <dt><dfn>'snapList(point1,point2,&hellip;)'</dfn></dt>
      <dd>Defines one or more discrete snap points for the <span>scroller</span>.
    <dt><dfn>'snapInterval(start, interval)'</dfn></dt>
      <dd>Defines a starting snap point and an interval at which additional snap points are defined.
          The first argument is the starting snap point and the second argument is the interval to
          repeat thereafter.
    <dt><dfn>'elements'</dfn></dt>
      <dd>Declares that the snap points for this scroller will be determined by the elements contained within.  In particular, by the combination of the elements' positions in layout and their corresponding scroll-snap-coordinate properties, in conjunction with this element's scroll-snap-axis property.
  </dl>
<h2 id="scroll-snap-axis">
Scroll Snap Axis: the 'scroll-snap-axis-x' and 'scroll-snap-axis-y properties</h2>
<p>The 'scroll-snap-axis-x' and 'scroll-snap-axis-y' properties are used to define the x and y coordinate within the <span>scroller</span> which element snap points will align with when the 'elements' value is used for the 'scroll-snap-points' property of the respective axis.</p>
  <table class=propdef>
    <tr>
      <th>Name:
      <td><dfn>scroll-snap-axis-x</dfn>, <dfn>scroll-snap-axis-y</dfn>
    <tr>
      <th><a href="#values">Value</a>:
      <td>&lt;length&gt;
    <tr>
      <th>Initial:
      <td>0px
    <tr>
      <th>Applies to:
      <td>block-level <span class="index-def">scrollers</span>
    <tr>
      <th>Inherited:
      <td>no
    <tr>
      <th>Percentages:
      <td>Refer to the padding-box of the <span>scroller</span>
    <tr>
      <th>Media:
      <td>interactive
    <tr>
      <th>Computed&nbsp;value:
      <td>specified value
    <tr>
      <th>Animatable:
      <td>no
    <tr>
      <th>Canonical order:
      <td><abbr title="follows order of property value definition">per grammar</abbr>
  </table>

  <dl>
    <dt><dfn>&lt;length&gt;</dfn></dt>
      <dd>Specifies the offset of the snap axis from the leading edge of the scroller.
  </dl>
<h2 id="scroll-snap-coordinate">
Scroll Snap Coordinate: the 'scroll-snap-coordinate-x' and 'scroll-snap-coordinate-y properties</h2>
<p>The 'scroll-snap-coordinate-x' and 'scroll-snap-coordinate-y' properties are used to define the x and y coordinate within the <span>element</span> which will align with the nearest ancestor scroller's snap-axis when the 'elements' value is used for the 'scroll-snap-points' property of the nearest ancestor scroller's respective axis.</p>
  <table class=propdef>
    <tr>
      <th>Name:
      <td><dfn>scroll-snap-coordinate-x</dfn>, <dfn>scroll-snap-coordinate-y</dfn>
    <tr>
      <th><a href="#values">Value</a>:
      <td>&lt;length&gt;
    <tr>
      <th>Initial:
      <td>0px
    <tr>
      <th>Applies to:
      <td>block-level elements
    <tr>
      <th>Inherited:
      <td>no
    <tr>
      <th>Percentages:
      <td>Refer to the element box used by the box-sizing property
    <tr>
      <th>Media:
      <td>interactive
    <tr>
      <th>Computed&nbsp;value:
      <td>specified value
    <tr>
      <th>Animatable:
      <td>no
    <tr>
      <th>Canonical order:
      <td><abbr title="follows order of property value definition">per grammar</abbr>
  </table>

  <dl>
    <dt><dfn>&lt;length&gt;</dfn></dt>
      <dd>Specifies the offset of the snap coordinate from the leading edge of the element box used by the box-sizing property.
  </dl>
<h2 id="conformance">
Conformance</h2>

<h3 id="conventions">
Document conventions</h3>

  <p>Conformance requirements are expressed with a combination of
  descriptive assertions and RFC 2119 terminology. The key words "MUST",
  "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
  "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this
  document are to be interpreted as described in RFC 2119.
  However, for readability, these words do not appear in all uppercase
  letters in this specification.

  <p>All of the text of this specification is normative except sections
  explicitly marked as non-normative, examples, and notes. [[!RFC2119]]</p>

  <p>Examples in this specification are introduced with the words "for example"
  or are set apart from the normative text with <code>class="example"</code>,
  like this:

  <div class="example">
    <p>This is an example of an informative example.</p>
  </div>

  <p>Informative notes begin with the word "Note" and are set apart from the
  normative text with <code>class="note"</code>, like this:

  <p class="note">Note, this is an informative note.</p>

<h3 id="conformance-classes">
Conformance classes</h3>

	Conformance to CSS Scroll Snap Points Module 1
	is defined for three conformance classes:
	<dl>
		<dt><dfn title="style sheet!!as conformance class">style sheet</dfn>
			<dd>A <a href="http://www.w3.org/TR/CSS21/conform.html#style-sheet">CSS
			style sheet</a>.
		<dt><dfn>renderer</dfn>
			<dd>A <a href="http://www.w3.org/TR/CSS21/conform.html#user-agent">UA</a>
			that interprets the semantics of a style sheet and renders
			documents that use them.
		<dt><dfn id="authoring-tool">authoring tool</dfn>
			<dd>A <a href="http://www.w3.org/TR/CSS21/conform.html#user-agent">UA</a>
			that writes a style sheet.
	</dl>

	A style sheet is conformant to CSS Scroll Snap Points Module 1
	if all of its statements that use syntax defined in this module are valid
	according to the generic CSS grammar and the individual grammars of each
	feature defined in this module.

	A renderer is conformant to CSS Scroll Snap Points Module 1
	if, in addition to interpreting the style sheet as defined by the
	appropriate specifications, it supports all the features defined
	by CSS Scroll Snap Points Module 1 by parsing them correctly
	and rendering the document accordingly. However, the inability of a
	UA to correctly render a document due to limitations of the device
	does not make the UA non-conformant. (For example, a UA is not
	required to render color on a monochrome monitor.)

	An authoring tool is conformant to CSS Scroll Snap Points Module 1
	if it writes style sheets that are syntactically correct according to the
	generic CSS grammar and the individual grammars of each feature in
	this module, and meet all other conformance requirements of style sheets
	as described in this module.

<h3 id="partial">
Partial implementations</h3>

	So that authors can exploit the forward-compatible parsing rules to
	assign fallback values, CSS renderers <strong>must</strong>
	treat as invalid (and <a href="http://www.w3.org/TR/CSS21/conform.html#ignore">ignore
	as appropriate</a>) any at-rules, properties, property values, keywords,
	and other syntactic constructs for which they have no usable level of
	support. In particular, user agents <strong>must not</strong> selectively
	ignore unsupported component values and honor supported values in a single
	multi-value property declaration: if any value is considered invalid
	(as unsupported values must be), CSS requires that the entire declaration
	be ignored.

<h3 id="experimental">
Experimental implementations</h3>

	To avoid clashes with future CSS features, the CSS2.1 specification
	reserves a <a href="http://www.w3.org/TR/CSS21/syndata.html#vendor-keywords">prefixed
	syntax</a> for proprietary and experimental extensions to CSS.

	Prior to a specification reaching the Candidate Recommendation stage
	in the W3C process, all implementations of a CSS feature are considered
	experimental. The CSS Working Group recommends that implementations
	use a vendor-prefixed syntax for such features, including those in
	W3C Working Drafts. This avoids incompatibilities with future changes
	in the draft.


<h3 id="testing">
Non-experimental implementations</h3>

	Once a specification reaches the Candidate Recommendation stage,
	non-experimental implementations are possible, and implementors should
	release an unprefixed implementation of any CR-level feature they
	can demonstrate to be correctly implemented according to spec.

	To establish and maintain the interoperability of CSS across
	implementations, the CSS Working Group requests that non-experimental
	CSS renderers submit an implementation report (and, if necessary, the
	testcases used for that implementation report) to the W3C before
	releasing an unprefixed implementation of any CSS features. Testcases
	submitted to W3C are subject to review and correction by the CSS
	Working Group.

	Further information on submitting testcases and implementation reports
	can be found from on the CSS Working Group's website at
	<a href="http://www.w3.org/Style/CSS/Test/">http://www.w3.org/Style/CSS/Test/</a>.
	Questions should be directed to the
	<a href="http://lists.w3.org/Archives/Public/public-css-testsuite">public-css-testsuite@w3.org</a>
	mailing list.

<h2 class=no-num id="acknowledgments">
Acknowledgments</h2>

	Many thanks to lots of people for their proposals and recommendations, some of which are incorporated into this document.

<h2 class=no-num id="references">
References</h2>

<h3 class="no-num" id="normative-references">
Normative references</h3>
<!--normative-->

<h3 class="no-num" id="other-references">
Other references</h3>
<!--informative-->

<h2 class="no-num" id="index">
Index</h2>
<!--index-->

<h2 class="no-num" id="property-index">
Property index</h2>
<!-- properties -->

</body>
</html>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-declaration:"~/SGML/HTML4.decl"
sgml-default-doctype-name:"html"
sgml-minimize-attributes:t
sgml-nofill-elements:("pre" "style" "br")
sgml-live-element-indicator:t
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-always-quote-attributes:t
sgml-indent-step:nil
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->