Compare commits

...
Sign in to create a new pull request.

6 commits

Author SHA1 Message Date
Rohit Sharma
98fe781fa5 WIP: Fix the Popper warning issue
- Set the default margin to 0 for dropdowns
- Set the required offset in dropdowns
2020-12-18 11:14:15 +05:30
joke2k
7270c8ddc3 fix dropdown offset docs 2020-12-18 11:14:14 +05:30
joke2k
7ab1dfea03 fix getOffset with function with test 2020-12-18 11:14:14 +05:30
joke2k
2090329d54 simplify offset config 2020-12-18 11:14:13 +05:30
joke2k
5d22c10d08 tests for dropdown offsets 2020-12-18 11:14:13 +05:30
joke2k
5c8890687a Restore offset option for dropdown component 2020-12-18 11:14:12 +05:30
4 changed files with 86 additions and 3 deletions

View file

@ -72,7 +72,7 @@ const PLACEMENT_RIGHT = isRTL ? 'left-start' : 'right-start'
const PLACEMENT_LEFT = isRTL ? 'right-start' : 'left-start'
const Default = {
offset: 0,
offset: [0, 2],
flip: true,
boundary: 'clippingParents',
reference: 'toggle',
@ -81,7 +81,7 @@ const Default = {
}
const DefaultType = {
offset: '(number|string|function)',
offset: '(array|string|function)',
flip: 'boolean',
boundary: '(string|element)',
reference: '(string|element)',
@ -289,6 +289,20 @@ class Dropdown extends BaseComponent {
return this._element.closest(`.${CLASS_NAME_NAVBAR}`) !== null
}
_getOffset() {
const { offset } = this._config
if (typeof offset === 'string') {
return offset.split(',').map(val => Number.parseInt(val, 10))
}
if (typeof offset === 'function') {
return popperData => offset(popperData, this._element)
}
return offset
}
_getPopperConfig() {
const popperConfig = {
placement: this._getPlacement(),
@ -304,6 +318,12 @@ class Dropdown extends BaseComponent {
options: {
fallbackPlacements: ['top', 'right', 'bottom', 'left']
}
},
{
name: 'offset',
options: {
offset: this._getOffset()
}
}]
}

View file

@ -54,6 +54,54 @@ describe('Dropdown', () => {
expect(dropdown.toggle).toHaveBeenCalled()
})
it('should create offset modifier correctly when offset option is a function', done => {
fixtureEl.innerHTML = [
'<div class="dropdown">',
' <button class="btn dropdown-toggle" data-bs-toggle="dropdown">Dropdown</button>',
' <div class="dropdown-menu">',
' <a class="dropdown-item" href="#">Secondary link</a>',
' </div>',
'</div>'
].join('')
const getOffset = jasmine.createSpy('getOffset').and.returnValue([10, 20])
const btnDropdown = fixtureEl.querySelector('[data-bs-toggle="dropdown"]')
const dropdown = new Dropdown(btnDropdown, {
offset: getOffset,
popperConfig: {
onFirstUpdate: state => {
expect(getOffset).toHaveBeenCalledWith({
popper: state.rects.popper,
reference: state.rects.reference,
placement: state.placement
}, btnDropdown)
done()
}
}
})
const offset = dropdown._getOffset()
expect(typeof offset).toEqual('function')
dropdown.show()
})
it('should create offset modifier correctly when offset option is a string into data attribute', () => {
fixtureEl.innerHTML = [
'<div class="dropdown">',
' <button class="btn dropdown-toggle" data-bs-toggle="dropdown" data-bs-offset="10,20">Dropdown</button>',
' <div class="dropdown-menu">',
' <a class="dropdown-item" href="#">Secondary link</a>',
' </div>',
'</div>'
].join('')
const btnDropdown = fixtureEl.querySelector('[data-bs-toggle="dropdown"]')
const dropdown = new Dropdown(btnDropdown)
expect(dropdown._getOffset()).toEqual([10, 20])
})
it('should allow to pass config to Popper with `popperConfig`', () => {
fixtureEl.innerHTML = [
'<div class="dropdown">',

View file

@ -22,7 +22,7 @@
display: none; // none by default, but block on "open" of the menu
min-width: $dropdown-min-width;
padding: $dropdown-padding-y $dropdown-padding-x;
margin: $dropdown-spacer 0 0; // override default ul
margin: 0; // Let Popper handle the space by offset
@include font-size($dropdown-font-size);
color: $dropdown-color;
text-align: left; // Ensures proper alignment if parent has it changed (e.g., modal footer)
@ -174,6 +174,11 @@
.dropdown-menu.show {
display: block;
&:not([data-popper-placement]) {
margin: $dropdown-spacer 0 0; // override default ul for dropdown not using Popper
}
}
// Dropdown section headers

View file

@ -896,6 +896,16 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
<td><code>'dynamic'</code></td>
<td>By default, we use Popper for dynamic positioning. Disable this with <code>static</code>.</td>
</tr>
<tr>
<td><code>offset</code></td>
<td>array | string | function</td>
<td><code>[0, 0]</code></td>
<td>
<p>Offset of the dropdown relative to its target.</p>
<p>When a function is used to determine the offset, it is called with an object containing the <code>popper</code> instance, the <code>refecence</code> Element and the <code>placement</code> as its first argument. The function must return an array with two numbers: <code>[<a href="https://popper.js.org/docs/v2/modifiers/offset/#skidding-1">skidding</a>, <a href="https://popper.js.org/docs/v2/modifiers/offset/#distance-1">distance</a>]</code>. The triggering element DOM node is passed as the second argument.</p>
<p>For more information refer to Popper.js's <a href="https://popper.js.org/docs/v2/modifiers/offset/#options">offset docs</a>.</p>
</td>
</tr>
<tr>
<td><code>popperConfig</code></td>
<td>null | object</td>