y5 API: Модуль y5

Ядро фреймфорка.
Содержит определения часто используемых переменных (версия браузера, тип операционной системы и т.п.) и набор функций для загрузки модулей.

Находится в базовом файле y5.js.

Пример:

Для загрузки модулей библиотек можно использовать удобный механизм динамической загрузки.
Для этого используется метод y5.require.

y5.require('Dom', function() {
    // здесь можно использовать функции y5.Dom
});

y5.require('URL', 'Classes', function() {
    // здесь можно использовать функции y5.URL и y5.Classes
});

$

Ссылка на y5.Dom.$.

y5.$(id) -> Element — элемент DOM

Имя аргумента	Тип	Описание
id	String

FALSE

Ссылка на y5.Vars.FALSE.

y5.FALSE -> Function

NULL

Ссылка на y5.Vars.NULL.

y5.NULL -> Function

TRUE

Ссылка на y5.Vars.TRUE.

y5.TRUE -> Function

UNDEF

Ссылка на y5.Vars.UNDEF.

y5.UNDEF -> String

VOID

Ссылка на y5.Vars.VOID.

y5.VOID -> Function

cookieEnabled

Ссылка на y5.Vars.cookieEnabled.

y5.cookieEnabled -> Boolean

domloaded

y5.domloaded -> Boolean

Логическая переменная. Устанавливается в true, когда происходит событие dom:loaded.

gecko_ver

Ссылка на y5.Vars.gecko_ver.

y5.gecko_ver -> Number

getBase

Устарело.

y5.getBase(file, charset) -> Object — Объект вида {path: 'http://www.yandex.ru/foo/', query: '?build=1', charset: 'utf-8'}

Возвращает данные скрипта по имени файла.

Имя аргумента	Тип	Описание
file	String	имя файла
charset	String	кодировка файла (если указана, то переопределяет кодировку, указанную в скрипте)

ie_ver

Ссылка на y5.Vars.ie_ver.

y5.ie_ver -> Number

is_gecko

Ссылка на y5.Vars.is_gecko.

y5.is_gecko -> Boolean

is_ie

Ссылка на y5.Vars.is_ie.

y5.is_ie -> Boolean

is_ie5

Ссылка на y5.Vars.is_ie5.

y5.is_ie5 -> Boolean

is_ie55

Ссылка на y5.Vars.is_ie55.

y5.is_ie55 -> Boolean

is_ie55up

Ссылка на y5.Vars.is_ie55up.

y5.is_ie55up -> Boolean

is_ie5up

Ссылка на y5.Vars.is_ie5up.

y5.is_ie5up -> Boolean

is_ie6down

Ссылка на y5.Vars.is_ie6down.

y5.is_ie6down -> Boolean

is_ie6up

Ссылка на y5.Vars.is_ie6up.

y5.is_ie6up -> Boolean

is_ie7down

Ссылка на y5.Vars.is_ie7down.

y5.is_ie7down -> Boolean

is_ie7up

Ссылка на y5.Vars.is_ie7up.

y5.is_ie7up -> Boolean

is_iphone

Ссылка на y5.Vars.is_iphone.

y5.is_iphone -> Boolean

is_khtml

Ссылка на y5.Vars.is_khtml.

y5.is_khtml -> Boolean

is_konq

Ссылка на y5.Vars.is_konq.

y5.is_konq -> Boolean

is_linux

Ссылка на y5.Vars.is_linux.

y5.is_linux -> Boolean

is_mac

Ссылка на y5.Vars.is_mac.

y5.is_mac -> Boolean

is_opera

Ссылка на y5.Vars.is_opera.

y5.is_opera -> Boolean

is_safari

Ссылка на y5.Vars.is_safari.

y5.is_safari -> Boolean

is_win

Ссылка на y5.Vars.is_win.

y5.is_win -> Boolean

loaded

y5.loaded(module)

Скрипт-модуль вызывает функцию по окончании загрузки всех требуемых модулей.

Имя аргумента	Тип	Описание
module	String	имя модуля (например, "foo.bar")

moduleName

y5.moduleName(module) -> String — имя модуля

Возвращает каноническое (полное) имя модуля.

Имя аргумента	Тип	Описание
module	String	имя модуля (например, "foo.bar")

Пример:

y5.moduleName("foo.bar");
// -> "y5:foo.bar"

moduleNamespace

y5.moduleNamespace(module) -> String — namespace модуля

Возвращает название библиотеки модуля.

Имя аргумента	Тип	Описание
module	String	имя модуля (например, "foo.bar")

Пример:

y5.moduleNamespace("foo.bar");
// -> "y5"

moduleObject

y5.moduleObject(module) -> Object, null — объект

Возвращает объект по имени модуля.

Имя аргумента	Тип	Описание
module	String	имя модуля (например, "foo.bar")

Пример:

y5.moduleNamespace("foo.bar");
// -> y5.foo.bar

moduleURL

y5.moduleURL(module, ext) -> String — URL, вида http://www.yandex.ru/[lib]/foo/bar.js

Возвращает URL модуля.

Имя аргумента	Тип	Описание
module	String	Имя модуля (например, "foo.bar")
ext	String	расширение файла модуля (по умолчанию - "js")

Пример:

y5.moduleURL("Dom");
// -> [base URL]/Dom.js

y5.moduleURL("Widget.Window", "css");
// -> [base URL]/Widget/Window.css

namespaceCharset

y5.namespaceCharset(namspace) -> String, null — кодировка

Возвращает кодировку файлов библиотеки.

Имя аргумента	Тип	Описание
namspace	String	имя библиотеки

Пример:

y5.namespaceCharset("Foo");
// -> "utf-8"

namespacePath

y5.namespacePath(namspace) -> String, null — путь

Возвращает путь к файлам библиотеки.

Имя аргумента	Тип	Описание
namspace	String	имя библиотеки

Пример:

y5.namespacePath("Foo");
// -> "http://www.yandex.ru/foo/"

opera_ver

Ссылка на y5.Vars.opera_ver.

y5.opera_ver -> Number

registerNamespace

y5.registerNamespace(namespace, filename, charset)

Регистрирует новую библиотеку модулей по имени файла.

Имя аргумента	Тип	Описание
namespace	String	имя, под которым регистрируется библиотека
filename	String	строка, которая входит в имя файла библиотеки
charset	String	кодировка файлов библиотеки

registerNamespaceByData

y5.registerNamespaceByData(namespace, data, charset)

Регистрирует новую библиотеку модулей по URL или объекту с данными о библиотеке.

Имя аргумента	Тип	Описание
namespace	String	имя, под которым регистрируется библиотека
data	Object, String	данные вида: {path: 'http://www.yandex.ru/foo/', query: '?build=1', charset: 'utf-8'} или путь к библиотеке.
charset	String	кодировка файлов библиотеки

require

y5.require(modules, callback)

Загружает требуемые модули и выполняет функцию после загрузки модулей.

Имя аргумента	Тип	Описание
modules	String, Array	"foo.bar"
callback	Function	функция, выполняемая на момент загрузки

safari_ver

Ссылка на y5.Vars.safari_ver.

y5.safari_ver -> Number

version

y5.version -> Number

Текущая версия фреймворка.