Skip to content

Commit

Permalink
update references from ui-shell to ui-kit
Browse files Browse the repository at this point in the history
  • Loading branch information
oli-hivemq committed Jul 25, 2024
1 parent 7ea17bb commit d8bf5ef
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/configs/draft-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ version-resolver:
- 'refactor'
default: patch
template: |
## Changes within UI Shell
## Changes within UI Kit
$CHANGES
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/draft-next-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:

jobs:
draft_release:
name: 'Draft UI Shell release'
name: 'Draft UI Kit release'
permissions:
contents: write
pull-requests: write
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish UI Shell to GitHub Packages
name: Publish UI Kit to GitHub Packages

on:
release:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# UI Shell
# UI Kit

UI Shell to share similar navigations between different applications.
The HiveMQ UI Kit provides components on top of Chakra UI for various applications.

## Development

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@hivemq/ui-shell",
"version": "0.2.3",
"name": "@hivemq/ui-kit",
"version": "0.2.32",
"type": "module",
"main": "./dist/index.cjs.js",
"module": "./dist/index.es.js",
Expand Down
12 changes: 6 additions & 6 deletions src/docs/Demo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import SimpleImplementation from './cookbook/SimpleImplementation?raw';

<Meta title='Introduction' />

# HiveMQ UI Shell 🐚
# HiveMQ UI Kit 🐚

The HiveMQ UI Shell is a template that frames the content of a page.
The HiveMQ UI Kit is a template that frames the content of a page.
It provides the most basic elements required to build a HiveMQ Application,
such as the header, sidebar navigation, and overlays.

## Installation

The HiveMQ UI Shell is available as an npm package in the GitHub Package Registry.
The HiveMQ UI Kit is available as an npm package in the GitHub Package Registry.
For that you need to generate a personal access token with the `read:packages` scope.
See [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages) for more information.

Expand All @@ -28,17 +28,17 @@ Set the token and scope in your local or project `.npmrc` file:
Then you can install the package with the following command:

```bash
npm install @hivemq/ui-shell
npm install @hivemq/ui-kit
```

## Cookbooks

Let's get started with maximum speed you can ether use the [interactive demo](/?path=/story/demo-interactive--primary)
or follow the steps below to add the UI Shell to your project.
or follow the steps below to add the UI Kit to your project.

## Demo

Checkout the [interactive demo](/?path=/story/demo-interactive--primary) below to see the UI Shell in action.
Checkout the [interactive demo](/?path=/story/demo-interactive--primary) below to see the UI Kit in action.

<Canvas of={DemoStories.Primary} layout='fullscreen' />

Expand Down
2 changes: 1 addition & 1 deletion src/docs/cookbook/FullDemo.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ export function FullDemo() {
</Heading>

<Text>
This is a full demo of the HiveMQ UI Shell. You can interact with the sidebar to change
This is a full demo of the HiveMQ UI Kit. You can interact with the sidebar to change
the active item.
</Text>
</VStack>
Expand Down
5 changes: 3 additions & 2 deletions src/modules/Content/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const Content = {
*/
Base: ContentRoot,
/**
* Root element for the UI Shell content that positions the HTML element on the grid and provides
* Root element for the UI Kit content that positions the HTML element on the grid and provides
* @requires Shell.Root - As the parent element that provides the layout / context for the Content.Root
*/
Root: ContentRoot,
Expand All @@ -19,5 +19,6 @@ export {
* @deprecated use ContentRootProps instead
*/
type ContentRootProps as ContentProps,
type ContentRootProps,
type ContentRootProps
} from './ContentRoot'

5 changes: 3 additions & 2 deletions src/modules/Shell/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { ShellContainer, ShellProvider, ShellRoot } from './ShellRoot'

export const Shell = {
/**
* Provider for the entire UI Shell this should be at the top of all elements,
* Provider for the entire UI Kit this should be at the top of all elements,
* even above `Shell.Root`
*
* @deprecated use `Shell.Root` instead since it provides functionality for both `Shell.Provider` and `Shell.Container`
Expand Down Expand Up @@ -30,5 +30,6 @@ export {
* @deprecated use `ShellRootProps` instead
*/
type ShellContainerProps as ShellProviderProps,
type ShellRootProps,
type ShellRootProps
} from './ShellRoot'

0 comments on commit d8bf5ef

Please sign in to comment.