diff --git a/DOCS.md b/DOCS.md index 735b5fa..2b8c8e2 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1 +1,127 @@ -# Документация по Find \ No newline at end of file +# Документация по Find +## Подключение +Find подключается как модуль (необходимо свойство ```type="module"```). Пример: +```html + + + + + + + Find + + + + + +
+ + + + +``` +В JS подключается директивой import: +```js +import Find from "/home/user/Find_js/Find.js"; +``` +## Устойство +В Find каждая страница является группой (group) с любым ID. Части, на которые поделен код, называются элементами и нумеруются с нуля. У каждой группы есть мета-свойства, например необходимые библиотеки. +## Создание группы +Группу можно создать явно, например: +```js +import Find from "/home/user/Find_js/Find.js"; +// Поиск по ID +const root = Find.search("my_app"); +const app = new Find(root); +app.group("com.example", []); +``` +Этот код создает пустую группу. +Также группа создаётся неявно при добавлении данных или мета-свойств. +Имя группы можно передавать первым аргументом в функции, но также можно выбрать одну группу и работать с ней: +```js +import Find from "/home/user/Find_js/Find.js"; +const root = Find.search("my_app"); +const app = new Find(root); +app.group("com.example", []).select("com.example"); +app.имя_функции([имя_группы,] данные); +``` +## Мета-свойства +Добавляются функцией meta. Например: +```js +import Find from "/home/user/Find_js/Find.js"; +const root = Find.search("my_app"); +const app = new Find(root); +app.select("com.example"); +app.meta([ + Find.css("bulma.min.css"), + '' +]); +``` +## Данные группы +```js +import Find from "/home/user/Find_js/Find.js"; +const root = Find.search("my_app"); +const app = new Find(root); +app.select("com.example"); +// Добавление +app.add(['']); +// Изменение +app.correct(0, '') +// Удаление +app.delete(0); +``` +## Рендер +Для рендера группы используется функция render. Для отрисовки текущей группы - draw: +```js +import Find from "/home/user/Find_js/Find.js"; +const root = Find.search("my_app"); +const app = new Find(root); +app.select("com.example"); +// Добавление +app.add(['']); +app.render("com.example"); +// Эквивалентно +app.draw(); +``` +## Map +Map - обьект на странице. Использует следующие функции: +```js +import Find from "/home/user/Find_js/Find.js"; +const root = Find.search("my_app"); +const app = new Find(root); +app.select("com.example"); +// Добавление +app.add(['']); +app.draw(); +const map = app.map(); +map.select(/* CSS-селектор */); // Вернет экземпляр map для выбранного элемента +map.read(); // Прочитать HTML +map.text(/* Текст для textContent */); // Без аргументов вернет текст элемента +map.html(/* html для замены */); // Без аргументов вернет html элемента +map.value(/* value для замены */); // Без аргументов вернет значение элемента +map.id(/* ID элемента */); // Вернет экземпляр map для выбранного элемента +map.tag(/* TAG элемента */); // Вернет экземпляр map для выбранного элемента +map.attach(/* событие */, /* функция */); // EventHandler +``` \ No newline at end of file