# @nsc-earth-v2/common

> - `Widget` is a base class that you can extend to create your own widgets. You can import it into your project: - `DomUtil` is a utility class that provides some DOM manipulation methods. [中文 Readme](./README_CN.md)

Latest version **1.0.1** (published 2024-02-27) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @nsc-earth-v2/common
pnpm add @nsc-earth-v2/common
yarn add @nsc-earth-v2/common
bun add @nsc-earth-v2/common
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-02-27 |
| First published | 2024-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hongfaqiu |
| Maintainers | wodehaochide |
| Keywords | cesium, widget |

## Links

- npm: https://www.npmjs.com/package/@nsc-earth-v2/common
- Repository: https://github.com/hongfaqiu/nsc-earth-v2
- Homepage: https://github.com/hongfaqiu/nsc-earth-v2#readme
- Issues: https://github.com/hongfaqiu/nsc-earth-v2/issues
- npm.io page: https://npm.io/package/@nsc-earth-v2/common

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-02-27

## README

# @nsc-earth-v2/common

- `Widget` is a base class that you can extend to create your own widgets. You can import it into your project:
- `DomUtil` is a utility class that provides some DOM manipulation methods.
  [中文 Readme](./README_CN.md)

## Installation

```bash
npm install --save @nsc-earth-v2/common
```

## Usage

```javascript
import { Widget, DomUtil } from "@nsc-earth-v2/common";
```

## Widget

`Widget` is a base class for widgets based on Cesium applications. It provides some common widget manipulation methods and properties.

### API

#### `constructor(viewer: Cesium.Viewer, wrapper: HTMLElement)`

Creates a new instance of the `Widget` class and attaches it to the specified Cesium Viewer.

##### Parameters

- `viewer`: The Cesium Viewer instance to attach the widget to.
- `wrapper`: The DOM element to mount the widget to.

#### `enabled`

A boolean property that controls whether the widget is enabled or not.

#### `ready`

A boolean property indicating whether the widget is ready or not.

#### `setContent(content: string | Element): Widget`

A method for setting the content of the widget.

##### Parameters

- `content`: A string or DOM element representing the content to set.

#### `hide()`

A method for hiding the widget.

#### `show()`

A method for showing the widget.

#### `destroy()`

A method for destroying the widget.

## DomUtil

`DomUtil` is a utility class that provides some DOM manipulation methods.

### API

#### `create(tagName: string, className: string, container: Element | null = null): HTMLElement`

Creates an HTML element with the specified `tagName`, sets its class to `className`, and optionally appends it to the `container` element.

##### Parameters

- `tagName`: The HTML tag name to create.
- `className`: The class name to set on the HTML element.
- `container` (optional): The container element to append the new element to.

#### `parseDom(domStr: string, className: string): HTMLDivElement`

Parses a string into a DOM element and returns a DIV element containing the element.

##### Parameters

- `domStr`: The string to parse.
- `className`: The class name to set on the DIV element.

---
_Source: https://npm.io/package/@nsc-earth-v2/common · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._