# ml-panel

> Library for creating sidebars

Latest version **1.1.1** (published 2024-03-26) · 0 weekly downloads

## Install

```sh
npm install ml-panel
pnpm add ml-panel
yarn add ml-panel
bun add ml-panel
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2024-03-26 |
| First published | 2023-08-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 329.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gercovv |

## Links

- npm: https://www.npmjs.com/package/ml-panel
- npm.io page: https://npm.io/package/ml-panel

## Dependencies (4)

- [vue](https://npm.io/package/vue.md) ^3.4.21
- [remeda](https://npm.io/package/remeda.md) ^1.56.0
- [@mloyalty/ui](https://npm.io/package/@mloyalty/ui.md) ^1.1.8
- [@vueuse/core](https://npm.io/package/@vueuse/core.md) ^10.9.0

## Recent versions

- 1.1.1 (latest) — 2024-03-26
- 1.1.0 — 2024-03-25
- 1.0.7 — 2023-10-30
- 1.0.6 — 2023-10-13
- 1.0.5 — 2023-10-07
- 1.0.4 — 2023-10-06
- 1.0.3 — 2023-09-07
- 1.0.2 — 2023-09-06
- 1.0.1 — 2023-09-06
- 1.0.0 — 2023-09-06
- 0.0.76 — 2023-09-06
- 0.0.5 — 2023-08-31
- 0.0.4 — 2023-08-30
- 0.0.3 — 2023-08-30
- 0.0.2 — 2023-08-30
- … 2 more at https://npm.io/package/ml-panel/versions

## README

# Установка

Способы установки MlPanel на ваш сайт:

1. [Установка с помощью пакетного менеджера `npm`](#использование-mlpanel-из-npm)
2. [Использование CDN пакета](#использование-mlpanel-из-сdn)

## Установка с помощью пакетного менеджера npm

`npm i ml-panel`

Пример использования сборки из npm:

```
import { MlPanelService } from 'ml-panel'

const panel = new MlPanelService({
  url: 'https://quiz.lctest.ru/', // Используется в примере, для установки запросите ссылку у менеджера
  code: 'ml-01-ml', // Используется в примере, для установки запросите уникальный код у менеджера
})

panel.init()
```

## Использование CDN пакета

Вы можете использовать MlPanel непосредственно из CDN с помощью тега script:

`<script src="https://unpkg.com/ml-panel@1/dist/ml-panel.iife.js"></script>`

### Использование глобальной сборки

Приведенная выше ссылка загружает глобальную сборку MlPanel, где все API верхнего уровня отображаются как свойства глобального объекта `MlPanel`. Вот полный пример использования глобальной сборки:

```
<script src="https://unpkg.com/ml-panel@1/dist/ml-panel.iife.js"></script>

<button onclick="panel.open()">Open MlPanel</button>

<script>
  const { MlPanelService } = MlPanel

  const panel = new MlPanelService({
    url: 'https://quiz.lctest.ru/', // Используется в примере, для установки запросите ссылку у менеджера
    code: 'ml-01-ml', // Используется в примере, для установки запросите уникальный код у менеджера
  })

  panel.init()
</script>
```

[Codepen demo](https://codepen.io/Gercov/pen/QWzNXpp)

### Использование сборки ES Module

Большинство современных браузеров теперь поддерживают ES модули изначально, поэтому мы можем использовать MlPanel из CDN через собственные ES-модули следующим образом:

```
<button id="ml-panel-open-btn">Open MlPanel</button>

<script type="module">
  import { MlPanelService } from 'https://unpkg.com/ml-panel@1/dist/ml-panel.js'

  const panel = new MlPanelService({
    url: 'https://quiz.lctest.ru/', // Используется в примере, для установки запросите ссылку у менеджера
    code: 'ml-01-ml', // Используется в примере, для установки запросите уникальный код у менеджера
  })

  panel.init()

  document.querySelector('#ml-panel-open-btn')
    .addEventListener('click', () => {
      panel.open()
    })
</script>
```

Обратите внимание, что мы используем `<script type="module">`, а импортированный URL-адрес CDN вместо этого указывает на сборку ES модулей из MlPanel.

[Codepen demo](https://codepen.io/Gercov/pen/LYMNKjv)

# Методы

## `.init()`

Обязательный метод для работы панели. Вызовите его, когда DOM будет доступен. Инициализирует панель в DOM, для дальнейшей ее работы.

```
const panel = new MlPanelService(...)

panel.init()
```

## `.open(payload?: OpenWidgetPropsPayload)`

Открывает панель. Принимает необязательный аргумент в виде объекта, который перезапишет уникальный код и объект с дополнительными данными, которые были заданы при создании экземпляра панели.

```
const panel = new MlPanelService({
  url '...',
  code: 'initial'
})

// Откроет панель с уникальным кодом "initial"
panel.open()

// Откроет панель с новым уникальным кодом
panel.open({
  code: "...",
})
```

## `.close()`

Скрывает видимость панели (Не удаляет из DOM)

```
const panel = new MlPanelService(...)

panel.close()
```

## `.destroy()`

Полностью удаляет панель из DOM

```
const panel = new MlPanelService(...)

panel.destroy()
```

---
_Source: https://npm.io/package/ml-panel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._