|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright (c) 2016 - 2023 Vaadin Ltd. |
| 4 | + * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/ |
| 5 | + */ |
| 6 | + |
| 7 | +/** |
| 8 | + * A mixin that provides basic functionality for the |
| 9 | + * `<vaadin-grid-selection-column>`. This includes properties, cell rendering, |
| 10 | + * and overridable methods for handling changes to the selection state. |
| 11 | + * |
| 12 | + * **NOTE**: This mixin is re-used by the Flow component, and as such must not |
| 13 | + * implement any selection state updates for the column element or the grid. |
| 14 | + * Web component-specific selection state updates must be implemented in the |
| 15 | + * `<vaadin-grid-selection-column>` itself, by overriding the protected methods |
| 16 | + * provided by this mixin. |
| 17 | + * |
| 18 | + * @polymerMixin |
| 19 | + */ |
| 20 | +export const GridSelectionColumnBaseMixin = (superClass) => |
| 21 | + class GridSelectionColumnBaseMixin extends superClass { |
| 22 | + static get properties() { |
| 23 | + return { |
| 24 | + /** |
| 25 | + * Width of the cells for this column. |
| 26 | + */ |
| 27 | + width: { |
| 28 | + type: String, |
| 29 | + value: '58px', |
| 30 | + }, |
| 31 | + |
| 32 | + /** |
| 33 | + * Flex grow ratio for the cell widths. When set to 0, cell width is fixed. |
| 34 | + * @attr {number} flex-grow |
| 35 | + * @type {number} |
| 36 | + */ |
| 37 | + flexGrow: { |
| 38 | + type: Number, |
| 39 | + value: 0, |
| 40 | + }, |
| 41 | + |
| 42 | + /** |
| 43 | + * When true, all the items are selected. |
| 44 | + * @attr {boolean} select-all |
| 45 | + * @type {boolean} |
| 46 | + */ |
| 47 | + selectAll: { |
| 48 | + type: Boolean, |
| 49 | + value: false, |
| 50 | + notify: true, |
| 51 | + }, |
| 52 | + |
| 53 | + /** |
| 54 | + * When true, the active gets automatically selected. |
| 55 | + * @attr {boolean} auto-select |
| 56 | + * @type {boolean} |
| 57 | + */ |
| 58 | + autoSelect: { |
| 59 | + type: Boolean, |
| 60 | + value: false, |
| 61 | + }, |
| 62 | + |
| 63 | + /** @protected */ |
| 64 | + _indeterminate: Boolean, |
| 65 | + |
| 66 | + /** @protected */ |
| 67 | + _selectAllHidden: Boolean, |
| 68 | + }; |
| 69 | + } |
| 70 | + |
| 71 | + static get observers() { |
| 72 | + return [ |
| 73 | + '_onHeaderRendererOrBindingChanged(_headerRenderer, _headerCell, path, header, selectAll, _indeterminate, _selectAllHidden)', |
| 74 | + ]; |
| 75 | + } |
| 76 | + |
| 77 | + /** |
| 78 | + * Renders the Select All checkbox to the header cell. |
| 79 | + * |
| 80 | + * @override |
| 81 | + */ |
| 82 | + _defaultHeaderRenderer(root, _column) { |
| 83 | + let checkbox = root.firstElementChild; |
| 84 | + if (!checkbox) { |
| 85 | + checkbox = document.createElement('vaadin-checkbox'); |
| 86 | + checkbox.setAttribute('aria-label', 'Select All'); |
| 87 | + checkbox.classList.add('vaadin-grid-select-all-checkbox'); |
| 88 | + root.appendChild(checkbox); |
| 89 | + // Add listener after appending, so we can skip the initial change event |
| 90 | + checkbox.addEventListener('checked-changed', this.__onSelectAllCheckedChanged.bind(this)); |
| 91 | + } |
| 92 | + |
| 93 | + const checked = this.__isChecked(this.selectAll, this._indeterminate); |
| 94 | + checkbox.__rendererChecked = checked; |
| 95 | + checkbox.checked = checked; |
| 96 | + checkbox.hidden = this._selectAllHidden; |
| 97 | + checkbox.indeterminate = this._indeterminate; |
| 98 | + } |
| 99 | + |
| 100 | + /** |
| 101 | + * Renders the Select Row checkbox to the body cell. |
| 102 | + * |
| 103 | + * @override |
| 104 | + */ |
| 105 | + _defaultRenderer(root, _column, { item, selected }) { |
| 106 | + let checkbox = root.firstElementChild; |
| 107 | + if (!checkbox) { |
| 108 | + checkbox = document.createElement('vaadin-checkbox'); |
| 109 | + checkbox.setAttribute('aria-label', 'Select Row'); |
| 110 | + root.appendChild(checkbox); |
| 111 | + // Add listener after appending, so we can skip the initial change event |
| 112 | + checkbox.addEventListener('checked-changed', this.__onSelectRowCheckedChanged.bind(this)); |
| 113 | + } |
| 114 | + |
| 115 | + checkbox.__item = item; |
| 116 | + checkbox.__rendererChecked = selected; |
| 117 | + checkbox.checked = selected; |
| 118 | + } |
| 119 | + |
| 120 | + /** |
| 121 | + * Updates the select all state when the Select All checkbox is switched. |
| 122 | + * The listener handles only user-fired events. |
| 123 | + * |
| 124 | + * @private |
| 125 | + */ |
| 126 | + __onSelectAllCheckedChanged(e) { |
| 127 | + // Skip if the state is changed by the renderer. |
| 128 | + if (e.target.checked === e.target.__rendererChecked) { |
| 129 | + return; |
| 130 | + } |
| 131 | + |
| 132 | + if (this._indeterminate || e.target.checked) { |
| 133 | + this._selectAll(); |
| 134 | + } else { |
| 135 | + this._deselectAll(); |
| 136 | + } |
| 137 | + } |
| 138 | + |
| 139 | + /** |
| 140 | + * Selects or deselects the row when the Select Row checkbox is switched. |
| 141 | + * The listener handles only user-fired events. |
| 142 | + * |
| 143 | + * @private |
| 144 | + */ |
| 145 | + __onSelectRowCheckedChanged(e) { |
| 146 | + // Skip if the state is changed by the renderer. |
| 147 | + if (e.target.checked === e.target.__rendererChecked) { |
| 148 | + return; |
| 149 | + } |
| 150 | + |
| 151 | + if (e.target.checked) { |
| 152 | + this._selectItem(e.target.__item); |
| 153 | + } else { |
| 154 | + this._deselectItem(e.target.__item); |
| 155 | + } |
| 156 | + } |
| 157 | + |
| 158 | + /** |
| 159 | + * Override to handle the user selecting all items. |
| 160 | + * @protected |
| 161 | + */ |
| 162 | + _selectAll() {} |
| 163 | + |
| 164 | + /** |
| 165 | + * Override to handle the user deselecting all items. |
| 166 | + * @protected |
| 167 | + */ |
| 168 | + _deselectAll() {} |
| 169 | + |
| 170 | + /** |
| 171 | + * Override to handle the user selecting an item. |
| 172 | + * @param {Object} item the item to select |
| 173 | + * @protected |
| 174 | + */ |
| 175 | + _selectItem(item) {} |
| 176 | + |
| 177 | + /** |
| 178 | + * Override to handle the user deselecting an item. |
| 179 | + * @param {Object} item the item to deselect |
| 180 | + * @protected |
| 181 | + */ |
| 182 | + _deselectItem(item) {} |
| 183 | + |
| 184 | + /** |
| 185 | + * IOS needs indeterminate + checked at the same time |
| 186 | + * @private |
| 187 | + */ |
| 188 | + __isChecked(selectAll, indeterminate) { |
| 189 | + return indeterminate || selectAll; |
| 190 | + } |
| 191 | + }; |
0 commit comments