Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.88 KB

polki-api.md

File metadata and controls

109 lines (68 loc) · 3.88 KB

Скриптовый интерфейс

Реализуется с помощью запросов POST. Запрос производится к странице, к которой подключены полки.

При запросе с полочных страниц не указывайте адрес, на который производится запрос:

$.post(location.href.replace(location.search, ''), {
	b: 'FancyContent',
	param: {
		'type': 'terms'
	}
}).done(function(data) {
	$.fancybox({
		content: data
	});
});

Запрос с произвольной страницы делайте на страницу с Полками. Остальное так же:

$.post('http://some.samsonpost.ru/assets/_layouts/', {
	b: 'TipContent',
	param: {
		'type': 'action-main'
	}
}).done(function(data) {
	$('.js-Tip-action').tipTip({
		content: data
	});
});

b, разметка компонента

  • b: имя компонента
  • param: объект с параметрами

bTypes, типы компонента и их разметка

  • bTypes: имя компонента

Далее описываются запросы для внутреннего применения, которые используют сами Полки.

start, активация сборки проекта и открытие его в проводнике

Изначально был внедрён для включения сборки проектов локальным Станком. Сейчас используется только для открытия папки проекта.

  • start: тип активации; поддерживает только значение gulp

open, открытие папок и файлов проекта

Используется в Полках для упрощения доступа к файлам. Папки открываются в Проводнике, файлы — в стандартной программе для типа файла.

Параметр open принимает несколько значений для открытия файлов. Имя файла передаётся в поле name.

  • pages — страница
  • b — компонент

Если не перередавать name, открывается папка со страницами и компонентами соответственно.

Следующие значения позволяют открывать папки проекта:

  • img — изображения
  • durl — встраиваемые изображения [устаревшее]
  • svg — наборы векторных пиктограмм [устаревшее]

Это значение поможет открыть файл стилей из массива (verstak|polki).json.path.styles. Нужно передать номер файла в упомянутом массиве.

  • css

create, создание файлов

Параметр create принимает следующие значения:

  • page
  • b

Работает только если есть name — название страницы или компонента.

Страницы и компоненты создаются из шаблонов. В Полках уже интегрированы шаблоны под каждый тип файла. Нестандартные шаблоны помещайте в папку с корневым файлом Полок.

  • tmplPage, шаблон страницы
  • tmplB, шаблон компонента

remove, удаление файлов

Параметр remove принимает следующие значения:

  • page
  • b

Работает только если есть name — название страницы или компонента.