sep-yui 0.0.25 → 0.0.27

package/README.md

@@ -1,26 +1,56 @@
-# Library SEP-YUI
+# Как работать с библиотекой
 
+### Установить нпм-пакет с библиотекой к себе в проект
+### Для работы библиотеки необходимы: node.js >= 20.14.0 и npm >= 10.7.0 
 
-#Как работать с библиотекой
+```bash
+bash
+    npm i sep-yui
+```
 
-<ol>
-  <li>Установить нпм-пакет с библиотекой к себе в проект
-<code>npm i spe-yui</code></li>
-  <li>Далее необходимо импортировать компоненты библиотеки в главный файл App.vue</li>
-  <li>Стили импортируются через путь "sep-yui/styles";</li>
-  <li>Спрайт подключается отдельно.</li>
-  <li>Далее подключаем импортированый компонент в проект, пробрасываем пропсы в него и пользуемся как при обычной разработке.</li>
-</ol>
+#### 1. Для использования библиотеки в проекте, необходимо импортировать компоненты библиотеки в главный файл проекта main.ts таким образом:
+```ts
+main.ts
+    import { createApp } from 'vue'
+////your code
+    import Ylibrary from 'sep-yui';
 
-#Разработчикам библиотеки
-<ul>
-<li>npm ci - for install all dependencies</li>
-<li>npm run dev - for development</li>
-<li>npm run build - for build production</li>
-<li>npm run build -  for build production and  publishing library, up version package</li>
-<li>npm run preview - for watch build</li>
-<li>npm run storybook - for testing components in storybook</li>
-<li>npm run build-storybook - for build storybook</li>
-</ul>
+    const app = createApp(App);
 
-Your welcome and your pleasure for codding!
+    app.use(Ylibrary)
+    app.mount('#app');
+```
+#### 1.1 Для выборочного импорта компонентов, можно использовать подключение такого вида.
+```ts
+main.ts
+    import { createApp } from 'vue'
+////your code
+    import {Toggle} from 'sep-yui'
+
+    const app = createApp(App);
+
+    app.component('Toggle', Toggle);
+    app.mount('#app');
+```
+#### 2. Стили импортируются через путь "sep-yui/styles" также в файле main.ts
+```ts
+main.ts
+    import { createApp } from 'vue'
+////your code
+    import 'sep-yui/styles'
+```
+#### 3. Далее просто пишем название компонента внутри проекта и используем как при обычной разработке на Vue. 
+```ts
+App.vue
+<template>
+    <Toggle 
+    {
+        props...
+    }
+    />
+</template>
+<script setup lang="ts">
+</script>
+<styles lang="scss">
+</styles>
+```

package/dist/assets/icons/icons.d.ts

@@ -0,0 +1,30 @@
+import { IvectorIcon } from './interface/interface';
+
+export declare const help: IvectorIcon;
+export declare const notification: IvectorIcon;
+export declare const moonFill: IvectorIcon;
+export declare const arrowLeft: IvectorIcon;
+export declare const chevronDown: IvectorIcon;
+export declare const chevronUp: IvectorIcon;
+export declare const dark: IvectorIcon;
+export declare const exitBig: IvectorIcon;
+export declare const exitSmall: IvectorIcon;
+export declare const exit: IvectorIcon;
+export declare const leftBigSmall: IvectorIcon;
+export declare const leftBig: IvectorIcon;
+export declare const light: IvectorIcon;
+export declare const notificationYes: IvectorIcon;
+export declare const plusSmall: IvectorIcon;
+export declare const plus: IvectorIcon;
+export declare const profileIcon: IvectorIcon;
+export declare const profile: IvectorIcon;
+export declare const rightBig: IvectorIcon;
+export declare const rightSmall: IvectorIcon;
+export declare const settings: IvectorIcon;
+export declare const settingsDark: IvectorIcon;
+export declare const searchNormal: IvectorIcon;
+export declare const search: IvectorIcon;
+export declare const filter: IvectorIcon;
+export declare const bgNotContent: IvectorIcon;
+export declare const document: IvectorIcon;
+export declare const baseDetail: IvectorIcon;

package/dist/assets/icons/interface/interface.d.ts

@@ -0,0 +1,5 @@
+export interface IvectorIcon {
+    name: string;
+    style: 'line' | 'solid';
+    path: string;
+}

package/dist/components/Icon/index.d.ts

@@ -0,0 +1,2 @@
+import * as Icons from '../../assets/icons/icons.ts';
+export default Icons;