https://github.com/itwin/changed-elements-react

A set of React components that help implement iTwin version comparison workflows
https://github.com/itwin/changed-elements-react

changed-elements itwin-platform itwinjs

Last synced: 11 months ago
JSON representation

A set of React components that help implement iTwin version comparison workflows

• Host: GitHub
• URL: https://github.com/itwin/changed-elements-react
• Owner: iTwin
• License: mit
• Created: 2022-10-27T12:51:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-07-09T21:15:49.000Z (11 months ago)
• Last Synced: 2025-07-09T22:29:27.163Z (11 months ago)
• Topics: changed-elements, itwin-platform, itwinjs
• Language: TypeScript
• Homepage:
• Size: 2.89 MB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# iTwin Changed Elements

[![CI](https://github.com/iTwin/changed-elements-react/actions/workflows/CI.yaml/badge.svg)](https://github.com/iTwin/changed-elements-react/actions/workflows/CI.yaml) [![CodeQL](https://github.com/iTwin/changed-elements-react/actions/workflows/codeql.yml/badge.svg)](https://github.com/iTwin/changed-elements-react/actions/workflows/codeql.yml)

## Packages

[@itwin/changed-elements-react](./packages/changed-elements-react/)

## Setup

```shell

pnpm install

```

## Commands

* `pnpm start` – starts the test app, available on [http://localhost:2363](http://localhost:2363)

  * To enable iTwin Platform features, create `packages/test-app-frontend/.env.local` file based on contents of `packages/test-app-frontend/.env`

* `pnpm test` – runs all unit tests

* `pnpm run cover` – runs all unit tests and calculates test coverage

* `pnpm run lint` – runs ESLint on all TypeScript files in this repository

* `pnpm run typecheck` – type checks all packages in this repository

## Contributing

### Issues

We welcome contributions to make this package better. You can submit feature requests or report bugs by creating an [issue](https://github.com/iTwin/changed-elements-react/issues).

### Versioning with Changesets

This repository uses [Changesets](https://github.com/changesets/changesets) to manage package versioning and changelogs. When making changes that affect the public API or behavior, please add a changeset by running:

```shell

pnpm changeset

```

Follow the prompts to describe your changes and select the appropriate version bump (major, minor, or patch). Versioning should follow [semver](https://semver.org/) conventions. If no version bump is required (such as for documentation-only changes), use `npx changeset --empty`.

When changesets are added and merged into the main branch, a release pull request (PR) will be automatically created by the Changesets GitHub Action. This PR will contain the version updates and changelog entries generated from your changesets. Review the release PR to ensure the version bumps and changelog messages are accurate before merging. Once the release PR is merged, the new package version will be published automatically.

For more details, see the [Changesets documentation](https://github.com/changesets/changesets/blob/main/README.md).

---

Copyright © Bentley Systems, Incorporated. All rights reserved. See [LICENSE.md](./LICENSE.md) for license terms and full copyright notice.