# palta-note

> Webcomponent palta-note following open-wc recommendations

Latest version **1.3.3** (published 2023-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install palta-note
pnpm add palta-note
yarn add palta-note
bun add palta-note
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2023-09-28 |
| First published | 2023-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 188.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | palta-note |
| Maintainers | mrniket |

## Links

- npm: https://www.npmjs.com/package/palta-note
- npm.io page: https://npm.io/package/palta-note

## Dependencies (3)

- [ohm-js](https://npm.io/package/ohm-js.md) ^17.1.0
- [typescript](https://npm.io/package/typescript.md) ^5.2.2
- [text-metrics](https://npm.io/package/text-metrics.md) ^3.0.0

## Recent versions

- 1.3.3 (latest) — 2023-09-28
- 1.3.2 — 2023-09-26
- 1.3.1 — 2023-09-26
- 1.3.0 — 2023-09-25
- 1.2.0 — 2023-09-25
- 1.1.1 — 2023-09-17
- 1.1.0 — 2023-09-17
- 1.0.3 — 2023-09-12
- 1.0.2 — 2023-09-12
- 1.0.1 — 2023-09-07
- 1.0.0 — 2023-09-06
- 0.5.1 — 2023-09-06
- 0.5.0 — 2023-09-06
- 0.4.3 — 2023-09-06
- 0.4.2 — 2023-09-06
- … 9 more at https://npm.io/package/palta-note/versions

## README

# \<palta-note>

\<palta-note> is a web component that displays compositions Bhatkhande notation system.

## Installation

```bash
npm i palta-note
```

## Usage

```html
<script type="module">
  import 'palta-note/palta-note.js';
</script>

<palta-note vibhags="1 2 0 3">
  Dha Dhin Dhin Dha
  Dha Dhin Dhin Dha
  Dha Tin Tin Ta
  Ta Dhin Dhin Dha
</palta-note>
```

The above should transform into:

![Screenshot of palta-note in action](./docs/screenshot.png)

You can also specify the taal and it will make sure that the matras fit into the correct structure of the taal:

```html
<palta-note taal="teental">
  Dha Dhin Dhin Dha Dha Dhin Dhin Dha
  Dha Tin Tin Ta
  Ta Dhin Dhin Dha
</palta-note>
```

which will produce the same output as above.

### Taals supported

\<palta-note> currently supports:
  - teental
  - rupak
  - ektaal
  - jhaptaal

### Shorthands

To save time with repeated matras or lines you can specify compositions like this:

```html
<palta-note taal="teental">
  Dha Dhin Dhin Dha x2
  Dha (Tin)x2 Ta
  Ta Dhin Dhin Dha
</palta-note>
```

This is equivalent to:

```html
<palta-note taal="teental">
  Dha Dhin Dhin Dha
  Dha Dhin Dhin Dha
  Dha Tin Tin Ta
  Ta Dhin Dhin Dha
</palta-note>
```


## Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

## Testing with Web Test Runner

To execute a single test run:

```bash
npm run test
```

To run the tests in interactive watch mode run:

```bash
npm run test:watch
```

## Local Demo

```bash
npm start
```

To run a local development server that serves the basic demo located in `index.html`

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