README.md

Telestion Client Common

npm: @wuespace/telestion-client-common

Common components for the development of Project-Specific Clients (PSCs) with the Telestion Client Ecosystem.

This package is included in PSCs bootstrapped using the Telestion Client CLI by default.

Installation

First, add it as dependency to your project:

pnpm add @wuespace/telestion-client-common
# or
npm install @wuespace/telestion-client-common

Please also check that you install a supported version of:

• react
• react-router
• react-router-dom
• @adobe/react-spectrum
• @spectrum-icons/illustrations
• @spectrum-icons/workflow
• @types/react

for React, routing and UI library support.

After installation, check out the provided components:

import { ConnectionIndicator } from '@wuespace/telestion-client-common';

function HeaderComponent() {
	return <ConnectionIndicator />;
}

For a full list of components, hooks and utility parts, check out the reference: https://wuespace.github.io/telestion-client/@wuespace/telestion-client-common/

Package structure

.
├── build (built in build script)
├── src
│   ├── components (components provided or used by the library)
│   │   ├── index.ts
│   │   └── [...]
│   ├── hooks
│   │   ├── abstractions (hooks that provide abstractions of other hooks)
│   │   │   ├── index.ts
│   │   │   └── [...]
│   │   ├── stores (zustand-Store-Hooks)
│   │   │   ├── index.ts
│   │   │   └── [...]
│   │   └── [...]
│   ├── lib (various utilities provided or used by the library)
│   │   ├── index.ts
│   │   └── [...]
│   ├── media (media files used by the library)
│   │   ├── default-app-logo.svg
│   │   └── [...]
│   └── index.ts
├── types (built in build script, gets assembled to single build/index.d.ts file)
│   ├── index.d.ts
│   └── [...]
├── CHANGELOG.md (DO NOT TOUCH! auto-generated changelog for the package)
├── LICENSE
├── package.json
├── README.md (you're here :P)
└── [...] (configuration files, etc.)

Contributing

If you want to contribute to this package, please take a look at the Telestion Client monorepo that manages this package, among other Telestion Client packages.

Contributors

Thank you to all contributors of this repository:

Made with contributors-img.

About

This is part of Telestion, a project by WüSpace e.V..