Class: Tabs

Extends

• module:nyc/Container~Container

Members

---

active :jQuery

The active tab

Type:

• jQuery

Source:

• Tabs.js, line 32

Methods

---

append(elements)

A method to append elements to the container

Parameters:

Name	Type	Description
elements	jQuery | Element | Array.<Element> | string	The element to append

Inherited From:

• module:nyc/Container~Container#append

Overrides:

• module:nyc/Container~Container#append

Source:

• Container.js, line 63

Returns:

The container

Type

jQuery

---

find(selector)

A method to return elements in the container

Parameters:

Name	Type	Description
selector	string	jQuery selector

Inherited From:

• module:nyc/Container~Container#find

Overrides:

• module:nyc/Container~Container#find

Source:

• Container.js, line 43

Returns:

The element

Type

jQuery

---

getContainer()

A method to return a control container HTML element wrapped in a JQuery

Inherited From:

• module:nyc/Container~Container#getContainer

Overrides:

• module:nyc/Container~Container#getContainer

Source:

• Container.js, line 33

Returns:

The the control container HTML element wrapped in a JQuery

Type

jQuery

---

off(eventName, evtHdlr [, hdlrScope])

Remove a previously connected event handler

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#off

Overrides:

• module:nyc/Container~Container#off

Source:

• EventHandling.js, line 82

---

on(eventName, evtHdlr [, hdlrScope])

Connect a function to an event

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#on

Overrides:

• module:nyc/Container~Container#on

Source:

• EventHandling.js, line 34

---

one(eventName, evtHdlr [, hdlrScope])

Connect a function to an event for a single invocation

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#one

Overrides:

• module:nyc/Container~Container#one

Source:

• EventHandling.js, line 45

---

open(tab)

Open a tab

Parameters:

Name	Type	Description
tab	jQuery | Element | string	Tab panel

Source:

• Tabs.js, line 46

---

prepend(elements)

A method to prepend elements to the container

Parameters:

Name	Type	Description
elements	jQuery | Element | Array.<Element> | string	The element to append

Inherited From:

• module:nyc/Container~Container#prepend

Overrides:

• module:nyc/Container~Container#prepend

Source:

• Container.js, line 53

Returns:

The container

Type

jQuery

---

trigger(eventName [, data])

Trigger a named event with event data

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to trigger
data	Object	<optional>	The event data

Inherited From:

• module:nyc/EventHandling~EventHandling#trigger

Overrides:

• module:nyc/Container~Container#trigger

Source:

• EventHandling.js, line 55

Type Definitions

---

Options

Contructor options for module:nyc/Tabs~Tabs

Type:

• Object

Properties:

Name	Type	Description
target	jQuery | Element | string	The target DOM node for Tabs
tabs	Array.<module:nyc/Tabs~Tabs.Tab>	The tabs

Source:

• Tabs.js, line 122

---

Tab

Object type to hold a tab definition

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
tab	jQuery | Element | string			The target DOM node for tab
title	string			The tab title
active	boolean	<optional>	false	Active state of the tab

Source:

• Tabs.js, line 132