Fix readme

CHANGELOG.md

@@ -80,3 +80,8 @@ Tested in JS and React. Errors in work in React applications are revealed.
 ##### 04.03.2023 - fix 0.3.1
 
 - Fixed import select.
+
+##### 04.03.2023 - fix 0.3.12
+
+- Optimized code.
+- Added error messages when using public methods.

README.md

@@ -1,8 +1,8 @@
 # CG-SELECT
 
-## version ~ 0.3.11
+## version ~ 0.3.12
 
-<a href="https://github.com/apuc/cg-select/blob/main/READMERU.md">ЧИТАТЬ НА РУССКОМ</a>
+<a href="https://git.itguild.info/apuc/cg-select/src/branch/master/READMERU.md">ЧИТАТЬ НА РУССКОМ</a>
 
 This component allows you to create a custom select. It offers more flexible customization and use of select.
 Customization, multi-selection and live search by elements are available.
@@ -19,10 +19,18 @@ Customization, multi-selection and live search by elements are available.
 
 ## Installation
 
+#### NPM
+
 ```
 npm i cg-select
 ```
 
+#### CDN
+
+```
+<script src="https://cdn.itguild.info/items/cg-select/latest/main.js"></script>
+```
+
 ## Usage
 
 ### To create a component, you need:
@@ -67,6 +75,74 @@ const dropdown = new CGSelect({
 });
 ```
 
+### An example of initialization a CGSelect in React.
+
+```javascript
+import { useEffect } from 'react';
+import CGSelect from 'cg-select';
+
+const App = () => {
+  useEffect(() => {
+    const drop = new CGSelect({
+      selector: '.cg-dropdown_selector',
+      placeholder: 'Выберите авто',
+      items: [
+        'BMW',
+        {
+          id: '213sade',
+          title: 'Opel',
+          value: 1,
+        },
+        'Mersedes',
+        'MAN',
+        'Ferari',
+      ],
+    });
+  }, []);
+
+  return (
+    <div className="App">
+      <button className="cg-dropdown cg-dropdown_selector"></button>
+    </div>
+  );
+};
+```
+
+### An example of initialization a CGSelect in Vue.
+
+```javascript
+<template>
+  <div>
+    <button class="cg-dropdown cg-dropdown_selector"></button>
+  </div>
+</template>
+
+<script>
+import CGSelect from "cg-select";
+
+export default {
+  mounted() {
+    const drop = new CGSelect({
+      selector: ".cg-dropdown_selector",
+      placeholder: "Выберите авто",
+      items: [
+        "BMW",
+        {
+          id: "213sade",
+          title: "Opel",
+          value: 1,
+        },
+        "Mersedes",
+        "MAN",
+        "Ferari",
+      ],
+    });
+    console.log(drop);
+  },
+};
+</script>
+```
+
 ## Example of different selects
 
 <a href="https://cg-select.itguild.info/">View live example</a>
@@ -87,10 +163,12 @@ All documentation on CG-SELECT is located in the folder of the same name. The do
 
 ## Compatibility
 
+
+
 | Application Compatibility |                                    JS                                    |                                                                      React                                                                       |                                 Angular                                 |                                   Vue                                   |
 | ------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: |
-| CG-SELECT                 | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) |
-| Comment                   |                 Tested in Js applications and it works.                  |                                               Works only with a crutch in the form `setTimeout()`                                                |                            not yet available                            |                            not yet available                            |
+| CG-SELECT                 | <img src="src/images/yes.png"></img> | <img src="src/images/yes.png"></img> | </img> <img src="src/images/no.png"></img> | </img> <img src="src/images/yes.png"></img> |
+| Comment                   |                 Tested in Js applications and it works.                  |                                                The select is initiated inside the `useEffect() `hook                                                |                            not yet available                            |                            The select is initiated inside the `mounted() `hook                            |
 
 ## History
 

READMERU.md

@@ -1,8 +1,8 @@
 # CG-SELECT
 
-## Версия ~ 0.3.11
+## Версия ~ 0.3.12
 
-<a href="https://github.com/apuc/cg-select/blob/main/README.md">English README</a>
+<a href="https://git.itguild.info/apuc/cg-select/src/branch/master/README.md">English README</a>
 
 Этот компонент позволяет вам создать пользовательский Select. Он предлагает более гибкую настройку и использование select.
 Доступна кастомизация, multi-selection, живой поиск по элементам и многое другое.
@@ -19,10 +19,18 @@
 
 ## Установка
 
+#### NPM
+
 ```
 npm i cg-select
 ```
 
+#### CDN
+
+```
+<script src="https://cdn.itguild.info/items/cg-select/latest/main.js"></script>
+```
+
 ## Использование
 
 ### Для создания компонента необходимо:
@@ -68,6 +76,74 @@ const dropdown = new CGSelect({
 });
 ```
 
+### Пример инициализации CGSelect в React.
+
+```javascript
+import { useEffect } from 'react';
+import CGSelect from 'cg-select';
+
+const App = () => {
+  useEffect(() => {
+    const drop = new CGSelect({
+      selector: '.cg-dropdown_selector',
+      placeholder: 'Выберите авто',
+      items: [
+        'BMW',
+        {
+          id: '213sade',
+          title: 'Opel',
+          value: 1,
+        },
+        'Mersedes',
+        'MAN',
+        'Ferari',
+      ],
+    });
+  }, []);
+
+  return (
+    <div className="App">
+      <button className="cg-dropdown cg-dropdown_selector"></button>
+    </div>
+  );
+};
+```
+
+### Пример инициализации CGSelect в Vue.
+
+```javascript
+<template>
+  <div>
+    <button class="cg-dropdown cg-dropdown_selector"></button>
+  </div>
+</template>
+
+<script>
+import CGSelect from "cg-select";
+
+export default {
+  mounted() {
+    const drop = new CGSelect({
+      selector: ".cg-dropdown_selector",
+      placeholder: "Выберите авто",
+      items: [
+        "BMW",
+        {
+          id: "213sade",
+          title: "Opel",
+          value: 1,
+        },
+        "Mersedes",
+        "MAN",
+        "Ferari",
+      ],
+    });
+    console.log(drop);
+  },
+};
+</script>
+```
+
 ## Примеры различных вариантов выбора.
 
 <a href="https://cg-select.itguild.info/">Рабочий пример</a>
@@ -88,8 +164,8 @@ const dropdown = new CGSelect({
 
 | Совместимость в приложениях |                                    JS                                    |                                                                      React                                                                       |                                 Angular                                 |                                   Vue                                   |
 | --------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: |
-| CG-SELECT                   | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) |
-| Комментарий                 |                     Протестировано в Js приложениях                      |                                                 Работает только с костылем в виде `setTimeout()`                                                 |                             пока недоступно                             |                             пока недоступно                             |
+| CG-SELECT                   | <img src="src/images/yes.png"></img> | <img src="src/images/yes.png"></img> | <img src="src/images/no.png"></img> | <img src="src/images/yes.png"></img> |
+| Комментарий                 |                     Протестировано в Js приложениях                      |                                                 Инициация селекта происходит внутри хука `useEffect()`                                                 |                             пока недоступно                             |                              Инициация селекта происходит внутри хука `mounted()`                             |
 
 ## История
 

docs/index.html

@@ -62,7 +62,7 @@
           </a>
 
           <a href="#version--0231" id="version--0231" style="color: inherit; text-decoration: none">
-            <h2>version ~ 0.3.1</h2>
+            <h2>version ~ 0.3.12</h2>
           </a>
           <p>
             This component allows you to create a custom select. It offers more flexible

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "cg-select",
-  "version": "0.3.11",
+  "version": "0.3.12",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "cg-select",
-      "version": "0.3.11",
+      "version": "0.3.12",
       "license": "ISC",
       "devDependencies": {
         "@babel/core": "^7.21.4",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cg-select",
-  "version": "0.3.11",
+  "version": "0.3.12",
   "source": "index.js",
   "main": "dist/main.js",
   "description": "Feature rich Select control for React/JS with multiselect, autocomplete and styling",

src/cg-select.ts

@@ -664,7 +664,7 @@ export default class CGSelect implements ICgSelect {
   private selectMode(nativeSelectMode: boolean) {
     let win = window.outerWidth;
 
-    if (nativeSelectMode === true) {
+    if (nativeSelectMode) {
       const select = this.element!.querySelector('.cg-select');
       const list = this.element!.querySelector('.list');
       const nativeSelect = this.element!.querySelector('.nativeSelect');
@@ -796,11 +796,12 @@ export default class CGSelect implements ICgSelect {
       const textNoRezult = this.element!.querySelector('.noRezult');
       const textNode = document.createTextNode(textInListSearch);
 
-      search!.setAttribute('placeholder', placeholder);
       search!.setAttribute('placeholder', placeholder);
 
       textNoRezult!.textContent = '';
       textNoRezult!.appendChild(textNode);
+    } else {
+      throw new Error('You cannot change the language if it is not enabled searchMode!');
     }
   }
 
@@ -811,20 +812,21 @@ export default class CGSelect implements ICgSelect {
    * @method buttonControl
    */
   public buttonControl(button: Element, method: string) {
-    if (this.listDisplayMode) {
-      return;
+    if (!this.listDisplayMode) {
+      this.buttonAction = button!;
+      button.addEventListener('click', () => {
+        switch (method.toLowerCase()) {
+          case 'open':
+            this.open(true);
+            break;
+          case 'close':
+            this.close();
+            break;
+        }
+      });
+    } else {
+      throw new Error('Sheet display enabled in listDisplayMode!');
     }
-
-    this.buttonAction = button!;
-    button.addEventListener('click', () => {
-      if (method.toLowerCase() === 'open') {
-        this.open(true);
-      } else if (method.toLowerCase() === 'close') {
-        this.close();
-      } else {
-        return;
-      }
-    });
   }
 
   /**
@@ -836,7 +838,7 @@ export default class CGSelect implements ICgSelect {
     const select = this.element!.querySelector('.cg-select');
     const nativeSelect = this.element!.querySelector('.nativeSelect');
 
-    if (value === true) {
+    if (value) {
       this.element!.setAttribute('disabled', 'true');
       nativeSelect!.setAttribute('disabled', 'true');
       select!.classList.add('disabled');
@@ -875,10 +877,8 @@ export default class CGSelect implements ICgSelect {
    */
   public deleteItem(index: number) {
     if (this.category) {
-      console.log('can`t add item to category');
-      return;
+      throw new Error('Unable to remove item from category!');
     }
-
     const item = this.items[index];
 
     this.items.splice(index, 1);
@@ -901,8 +901,7 @@ export default class CGSelect implements ICgSelect {
    */
   public selectIndex(index: number) {
     if (this.category) {
-      console.log('can`t add item to category');
-      return;
+      throw new Error('Unable to select item from category!');
     }
 
     const options = this.element!.querySelectorAll('.list__item') as NodeListOf<HTMLElement>;

webpack.config.js

@@ -7,11 +7,8 @@ module.exports = {
     path: path.resolve(__dirname, 'dist'),
     filename: 'main.js',
     clean: true,
-    library: {
-      name: 'CGSelect',
-      type: 'window',
-      export: 'default',
-    },
+    library: 'CGSelect',
+    libraryTarget: 'umd',
   },
   // devServer: {
   //   open: true,