Debian Codegraph @

packages/popper/src/methods/placements.js

raw
1 /**
2 * List of accepted placements to use as values of the `placement` option.<br />
3 * Valid placements are:
4 * - `auto`
5 * - `top`
6 * - `right`
7 * - `bottom`
8 * - `left`
9 *
10 * Each placement can have a variation from this list:
11 * - `-start`
12 * - `-end`
13 *
14 * Variations are interpreted easily if you think of them as the left to right
15 * written languages. Horizontally (`top` and `bottom`), `start` is left and `end`
16 * is right.<br />
17 * Vertically (`left` and `right`), `start` is top and `end` is bottom.
18 *
19 * Some valid examples are:
20 * - `top-end` (on top of reference, right aligned)
21 * - `right-start` (on right of reference, top aligned)
22 * - `bottom` (on bottom, centered)
23 * - `auto-end` (on the side with more space available, alignment depends by placement)
24 *
25 * @static
26 * @type {Array}
27 * @enum {String}
28 * @readonly
29 * @method placements
30 * @memberof Popper
31 */
32 export default [
33 'auto-start',
34 'auto',
35 'auto-end',
36 'top-start',
37 'top',
38 'top-end',
39 'right-start',
40 'right',
41 'right-end',
42 'bottom-end',
43 'bottom',
44 'bottom-start',
45 'left-end',
46 'left',
47 'left-start',
48 ];