rename option to anchorPreference

Author: anthony-hull

src/ui/popup.js

@@ -20,7 +20,7 @@ const defaultOptions = {
  focusAfterOpen: true,
  className: '',
  maxWidth: "240px",
- stickyAnchor: 'bottom'
+ anchorPreference: 'bottom'
 };
 
 export type Offset = number | PointLike | {[_: Anchor]: PointLike};
@@ -34,7 +34,7 @@ export type PopupOptions = {
  offset?: Offset,
  className?: string,
  maxWidth?: string,
- stickyAnchor: Anchor
+ anchorPreference: Anchor
 };
 
 const focusQuerySelector = [
@@ -59,7 +59,7 @@ const focusQuerySelector = [
  * map moves.
  * @param {boolean} [options.focusAfterOpen=true] If `true`, the popup will try to focus the
  * first focusable element inside the popup.
- * @param {string} [options.stickyAnchor='bottom'] - A string to set the preference for where the anchor will be
+ * @param {string} [options.anchorPreference='bottom'] - A string to set the preference for where the anchor will be
  * dynamically set. Options are `'center'`, `'top'`, `'bottom'`, `'left'`, `'right'`, `'top-left'`, `'top-right'`,
  * `'bottom-left'`, and `'bottom-right'`.
  * @param {string} [options.anchor] - A string indicating the part of the popup that should
@@ -580,7 +580,7 @@ export default class Popup extends Evented {
  }
 
  if (anchorComponents.length === 0) {
- return this.options.stickyAnchor;
+ return this.options.anchorPreference;
  }
  return ((anchorComponents.join('-'): any): Anchor);
 

test/unit/ui/popup.test.js

@@ -480,13 +480,13 @@ test('Popup automatically anchors to top if its bottom offset would push it off-
  t.end();
 });
 
-test('Popup automatically anchors to its sticky position if no offset would push it off-screen', (t) => {
+test('Popup automatically anchors to the user specified preferred position if will be on-screen', (t) => {
  const map = createMap(t);
  const point = new Point(containerWidth / 2, containerHeight / 2);
  const options = {offset: {
  'bottom': [0, 0],
  'top': [0, 0]
- }, stickyAnchor: 'left'};
+ }, anchorPreference: 'left'};
  const popup = new Popup(options)
  .setLngLat([0, 0])
  .setText('Test')