# web-widgets

**Repository Path**: weiphone_8/web-widgets

## Basic Information

- **Project Name**: web-widgets
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: RTE-v-4
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-25
- **Last Updated**: 2024-09-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web widgets

The repository of platform-supported widgets and modules for Mendix.

**For issues and bugs related to CSS, Widgets, Atlas, JS Actions, or this repository, please contact** [Mendix Support](https://support.mendix.com)

## Prerequisites

-   ![Current node engine](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmendix%2Fweb-widgets%2Fmain%2Fpackage.json&query=%24.engines.node&label=node&color=%23339933) version of [Node.js](https://nodejs.org/en/download)

-   ![Current pnpm version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmendix%2Fweb-widgets%2Fmain%2Fpackage.json&query=%24.engines.pnpm&label=pnpm&color=%23f69220) version of [pnpm](https://pnpm.io/installation)

## Development

1. Clone the repo.

```sh
$ git clone https://github.com/mendix/web-widgets.git
```

2. Install the dependencies.

```sh
$ cd web-widgets
$ pnpm install
```

3. Go to the widget (package) you want to work on, set `MX_PROJECT_PATH`, and run `pnpm start`.

```sh
$ cd packages/pluggableWidgets/datagrid-web/

# Mac and Linux:
$ export MX_PROJECT_PATH="$HOME/Documents/Mendix/DataBoardApp"

# For Windows (PowerShell):
# $env:MX_PROJECT_PATH = 'C:\Users\Tom\Documents\Mendix\DataBoardApp'

$ pnpm start
```

4. Go to Mendix Studio Pro and run `App>Synchronize App Directory` to update the widget code in the project. If your app is already running, restart it.

5. Keep code clean: run `pnpm test` and `pnpm lint`.

```sh
$ pnpm lint
...
$ pnpm test
```

Note: run `pnpm test --watch` to start unit tests in watch mode.

## Contributing

See [CONTRIBUTING.md](https://github.com/mendix/web-widgets/blob/main/CONTRIBUTING.md).

## Raising problems/issues

-   We encourage everyone to open a support ticket through [Mendix Support](https://support.mendix.com) in case of problems with widgets or scaffolding tools (Pluggable Widgets Generator or Pluggable Widgets Tools).