https://github.com/itwin/saved-views
Client-side code for managing saved views in iTwin applications
https://github.com/itwin/saved-views
itwinjs saved-views
Last synced: 5 months ago
JSON representation
Client-side code for managing saved views in iTwin applications
- Host: GitHub
- URL: https://github.com/itwin/saved-views
- Owner: iTwin
- License: mit
- Created: 2023-07-31T13:39:35.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T12:22:00.000Z (about 2 years ago)
- Last Synced: 2024-05-22T12:44:06.948Z (about 2 years ago)
- Topics: itwinjs, saved-views
- Language: TypeScript
- Homepage:
- Size: 1.62 MB
- Stars: 0
- Watchers: 21
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# iTwin Saved Views
[](https://github.com/iTwin/saved-views/actions/workflows/CI.yaml) [](https://github.com/iTwin/saved-views/actions/workflows/codeql.yml)
## Packages
| Repository | npmjs |
| ----------------------------------------------------------- | --------------------------------------------------------------- |
| [@itwin/saved-views-client](./packages/saved-views-client/) | [link](https://www.npmjs.com/package/@itwin/saved-views-client) |
| [@itwin/saved-views-react](./packages/saved-views-react/) | [link](https://www.npmjs.com/package/@itwin/saved-views-react) |
## Development setup
* Install project dependencies.
```shell
npx pnpm install
```
* Start the test application.
```shell
npm start
```
* You can now edit TypeScript and CSS source files and changes will automatically be reflected in the test app.
## Top-level commands
* `npm start` – starts the test app which can be accessed at [http://localhost:7948](http://localhost:7948)
* To enable app features that use [iTwin Platform](https://developer.bentley.com/), see [`packages/test-app-frontend/.env`](./packages/test-app-frontend/.env) file.
* `npm run lint` – runs ESLint on all TypeScript files in this repository
* `npm 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/saved-views/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 `pnpm 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.