its_ui_vite 0.0.1 → 0.0.3

package/README.md

@@ -1,5 +1,44 @@
 # UI Kit для Интелектуальной Транспортной Системы (ИТС) для Vue3
 
+## старт 
+
+* если не авторизован
+
+1. Заходим в github -> Профиль -> настройки -> Developer settings (https://github.com/settings/apps)
+2. далее: Personal access tokens -> Tokens (classic)
+3. Создаём токен(подробнее: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens), его нужно сохранить его потом не достать
+4. логинемся: 
+```
+npm login --registry=https://npm.pkg.github.com --scope=@lopanovco
+Username: YOUR_USERNAME
+Password: YOUR_PERSONAL_ACCESS_TOKEN со скопом 'read:packages'
+```
+
+* работа
+
+
+для начала установм: ```npm i its_ui_vite```
+
+пример использования (подробнее в *components props*): 
+```
+
+<template>
+  <CButton :disabled="true" variant="text">
+    disable
+  </CButton>
+</template>
+
+<script>
+import { CButton } from 'its_ui_vite'
+
+export default {
+  components: {
+    CButton,
+  },
+}
+</script>
+```
+
 ## components props
 
 * CButton 
@@ -11,6 +50,8 @@
   color: 'green' | 'black',
   disabled: Boolean,
 }
+
+slots: ['без имени']
 ```
 
 * CTabs 
@@ -18,7 +59,7 @@
 ```
 {
   tabs: Record<string, any> & { id: any, text: string }[],
-  activeId: any,
+  activeId: any, <!-- activeId должен быть в tabs -->
 }
 ```
 
@@ -35,6 +76,9 @@
   placeholder: string,
   value: string, 
 }
+
+slots: ['successIcon' <!-- есть дефольное значение -->, 'errorIcon' <!-- есть дефольное значение -->, 'customIcon']
+
 ```
 
 * CCheckbox 
@@ -50,6 +94,8 @@
   name:string,
   value: string, 
 }
+
+slots: ['без имени' <!-- есть дефольное значение (props.text) -->]
 ```
 
 * CSelect 
@@ -69,6 +115,8 @@
   position: 'top' | 'bottom',
   interactive: Boolean,
 }
+
+slots: ['icon' <!-- есть дефольное значение -->, 'content']
 ```
 
 * CPopup 
@@ -77,6 +125,18 @@
 {
   <!-- нет props -->
 }
+
+slots: ['title', 'content']
+```
+
+* CScroll 
+
+```
+{
+  <!-- нет props -->
+}
+
+slots: ['без имени']
 ```
 
 * CAlert 
@@ -88,6 +148,8 @@
   width: string,
   text: string,
 }
+
+slots: ['без имени' <!-- есть дефольное значение (props.text) -->]
 ```
 
 ## Docker

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "its_ui_vite",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "./src/libIndex.js",
   "module": "./src/libIndex.js",
   "files": [
@@ -30,5 +30,8 @@
     "@vitejs/plugin-vue": "^4.6.2",
     "sass": "^1.69.5",
     "vite": "^5.0.8"
+  },
+  "peerDependencies": {
+    "sass": ">=1"
   }
 }

package/src/components/CPopup.vue

@@ -1,11 +1,11 @@
 <template>
   <div class="c-popup">
     <div class="c-popup__title">
-      <slot name="title">Label</slot>
+      <slot name="title"></slot>
     </div>
 
     <div class="c-popup__content">
-      <slot name="content">Content goes here</slot>
+      <slot name="content"></slot>
     </div>
   </div>
 </template>

package/src/libIndex.js

@@ -1,11 +1,11 @@
-import CButton from './src/components/CButton.vue';
-import CTabs from './src/components/CTabs.vue';
-import CInput from './src/components/CInput.vue';
-import CCheckbox from './src/components/CCheckbox.vue'; 
-import CSelect from './src/components/CSelect.vue'; 
-import CTooltip from './src/components/CTooltip.vue';
-import CPopup from './src/components/CPopup.vue';
-import CAlert from './src/components/CAlert.vue';
+import CButton from './components/CButton.vue';
+import CTabs from './components/CTabs.vue';
+import CInput from './components/CInput.vue';
+import CCheckbox from './components/CCheckbox.vue'; 
+import CSelect from './components/CSelect.vue'; 
+import CTooltip from './components/CTooltip.vue';
+import CPopup from './components/CPopup.vue';
+import CAlert from './components/CAlert.vue';
 
 import './assets/scss/main.scss'