Determines if the target element is considered an "anchor". If the plugin is bound to the document, these are the selectors used to delegate bindings for anchors.

If no option was specified, but the plugin was initialized on normal elements, the selector used will override this option. See Usage for more details.

'h1,h2,h3,h4,[data-anchor]'

@todo Document this

true

@todo Document this

300

Searches for any nearby deprecated named anchors (<a name="..."></a>) to use as the anchor ID if the target element has no id attribute present.

If enabled, the plugin looks for the first named anchor sibling that immediately precedes or follows the target element.

If no sibling named anchor is found, the plugin will instead look for the first available named anchor child inside the target element.

If a named anchor is found, its name attribute will be used as the anchor ID and the found named anchor element will be removed from the DOM.

If no named anchor is found, then the plugin will proceed to auto-generate an ID for the anchor (if enabled).

false

If the target element is considered an anchor and does not have an id attribute (or name attribute if the element is <a>), then an anchor ID can automatically be generated by the text contents of the target element.

If the target element does not have any text content and no ID can be generated, then the anchor is considered to be invalid and will not be shown.

true

@todo Document this

'append'

@todo Document this

'<span class="glyphicon glyphicon-link" aria-hidden="true"></span>'

@todo Document this

'[data-anchor-ignore]:not([data-anchor-ignore="false"]),[data-dismiss],[data-slide],[data-toggle]:not([data-toggle="anchor"])'

Determines if the target element is considered an "anchor link". If the plugin is bound to the document, these are the selectors used to delegate bindings for anchor links.

If no option was specified, but the plugin was initialized on normal elements, the selector used will override this option. See Usage for more details.

'a[href*="#"],[data-toggle="anchor"]'

Normalizes generated anchor IDs to be more human readable and consistent with other anchors on the page.

To disable all normalizations, pass false to the entire option.

!{
  // The character to use when converting or replacing characters.
  separator: '-', // string | ''

  // The following options appear in the order they are executed.

  // Places a separator before uppercase letters.
  convertCamel: true, // boolean

  // Converts the case.
  convertCase: 'lower', // 'upper' | 'lower' | false

  // Converts matching characters to the separator.
  convert: /[\s_.(){}\[\]]/g, // RegExp | string | false

  // Removes matching characters, in this case: non-alphanumeric.
  strip: /[^\w-]/gi, // RegExp | string | false

  // Ensures no concurrent separators (i.e. some--id).
  singleSeparator: true, // boolean

  // Trims beginning and ending separators (i.e. -some-id-).
  trim: true, // boolean

  // Limits length of the final ID.
  maxLength: 32 // number | false
}
          

@todo Document this

20

@todo Document this

false

@todo Document this

false

@todo Document this

true

How to position the anchor tooltip - top | bottom | left | right | auto.
When "auto" is specified, it will dynamically reorient the anchor tooltip. For example, if placement is "auto left", the anchor tooltip will display to the left when possible, otherwise it will display right.

When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.

'auto left'

@todo Document this

true

@todo Document this

true

Base HTML to use when creating the anchor tooltip.

The anchor tooltip's icon option will be injected into the link (a element).

'<span class="anchor-link" role="tooltip"><a href="#anchor"></a></span>'

How anchor tooltips and links are triggered - click | hover | focus | manual.

If a string is supplied, the trigger is applied to both anchors and anchor links.

You may pass multiple triggers; separate them with a space.

!{
  anchors: 'hover focus',
  links: 'click'
}
          

Keeps the anchor tooltip within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }

!{
  selector: 'body',
  padding: 0
}
          

Apply a CSS fade transition when showing or hiding the anchor tooltip upon hovering on the anchor.

true

Delay showing and hiding the anchor tooltip (ms) - does not apply to manual trigger type

If a number is supplied, delay is applied to both hide/show

Object structure is:

!{
  show: 500,
  hide: 100
}
          

0

Anchor tooltips are always attached directly to the anchor. This is needed for relative positioning so the anchor tooltip does not disappear.

An anchor tooltip uses an icon for its content. It always inserts the icon option using the $.html() method.

An anchor tooltip uses an icon for its content.