From ea28f7472cb7a70cb0401fa29cfb6c0324c03641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=94=D0=BC=D0=B8=D1=82=D1=80=D0=B8=D0=B9=20=D0=9C=D0=B0?= =?UTF-8?q?=D0=BB=D1=8E=D0=B3=D0=B8=D0=BD?= <d.malygin@iqdev.digital> Date: Wed, 18 Dec 2024 17:26:33 +0500 Subject: [PATCH] docs: edit README.md --- README.md | 47 +++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index bf8163a..0866e44 100644 --- a/README.md +++ b/README.md @@ -16,29 +16,40 @@ - ToggleSwitch; - Divider. -## Components count: 10 -## Bundle size: 248.7KB - -### ÐаÑтройка Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ - +--- +## ÐžÐ±Ñ‰Ð°Ñ Ð¸Ð½Ñ„Ð¾Ñ€Ð¼Ð°Ñ†Ð¸Ñ +### Components count: 10 +### Bundle size: 254.6KB +--- +## Важные моменты при разработке +### Общее начало шаблона Ð´Ð»Ñ ÐºÐ¾Ð¼Ð¿Ð¾Ð½ÐµÐ½Ñ‚Ð¾Ð²: +``` +const props = withDefaults(defineProps<IProps>(), { + +}); +const emit = defineEmits(['']); +const visible = defineModel(''); +watch(, () => {}); +const computed = computed(() => ); +``` +- I*Componentname*Props вмеÑто ```IProps```; +- watchers поÑле defineModel; +- далее - computeds; +- затем - функции (handlers). +### ПоÑле ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð¸ÐºÐ¾Ð½ÐºÐ¸: +1. Добавить иконку в iconsSet (src/common/constants/icons); +2. Добавить иконку в ÑоответÑтвующий маÑÑив в App.vue. +--- +## ÐаÑтройка Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ +### УÑтановка завиÑимоÑтей: ```sh yarn ``` - -### ПроÑмотр ÑущеÑтвующих иконок в виде ÑпиÑка и теÑтирование компонентов - +### ПроÑмотр ÑущеÑтвующих иконок в виде ÑпиÑка и теÑтирование компонентов: ```sh yarn dev ``` - -### Проверка типов, компилÑÑ†Ð¸Ñ Ð¸ Ð¼Ð¸Ð½Ð¸Ð¼Ð¸Ð·Ð°Ñ†Ð¸Ñ Ð´Ð»Ñ production - +### Проверка типов, компилÑÑ†Ð¸Ñ Ð¸ Ð¼Ð¸Ð½Ð¸Ð¼Ð¸Ð·Ð°Ñ†Ð¸Ñ Ð´Ð»Ñ production: ```sh yarn build -``` - -## Важные моменты при разработке - -ПоÑле ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð¸ÐºÐ¾Ð½ÐºÐ¸: -1. Добавить иконку в iconsSet (src/common/constants/icons); -2. Добавить иконку в ÑоответÑтвующий маÑÑив в App.vue. \ No newline at end of file +``` \ No newline at end of file -- GitLab