Skip to content
This repository has been archived by the owner on Jul 17, 2024. It is now read-only.

Commit

Permalink
Merge pull request #86 from turistikrota/release/v0.1.1
Browse files Browse the repository at this point in the history
release/v0.1.1: release the version and update the docs
  • Loading branch information
9ssi7 authored Jul 20, 2023
2 parents 74a9d48 + a47382e commit f2c635e
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 6 deletions.
3 changes: 2 additions & 1 deletion apps/docs/.storybook/preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ const preview: Preview = {
'Documentation',
['Introduction', 'Package Structure', 'Customization', 'Eslint Configuration', 'Prettier Configuration'],
'Components',
['Accessibility', 'Section', 'Form', '*'],
['Accessibility', 'Section', 'Form', 'Headers', '*'],
'Hooks',
['useToast', '*'],
'Pages',
'Utils',
'Theme',
],
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"build-storybook": "storybook build"
},
"dependencies": {
"@turistikrota/ui": "0.0.30",
"@turistikrota/ui": "^0.1.1",
"boxicons": "^2.1.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand Down
20 changes: 19 additions & 1 deletion apps/docs/src/stories/components/headers/MobileHeader.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
import { Meta } from '@storybook/blocks'
import { Meta, Canvas } from '@storybook/blocks'
import MobileHeader from '@turistikrota/ui/headers/mobile'

<Meta title='Components/Headers/Mobile' />

# Mobile Header

Mobile header is used to display header on mobile devices.

Features:

- Fixed position
- Left, right and fill slots

<Canvas>
<MobileHeader>
<MobileHeader.Left>
<span className='dark:text-white'>Set your logo here</span>
</MobileHeader.Left>
<MobileHeader.Fill className='hidden md:flex'>{``}</MobileHeader.Fill>
<MobileHeader.Right>
<span className='dark:text-white'>Set login and register buttons here</span>
</MobileHeader.Right>
</MobileHeader>
</Canvas>

## Usage

```js
Expand Down
18 changes: 17 additions & 1 deletion apps/docs/src/stories/components/headers/TopHeader.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
import { Meta } from '@storybook/blocks'
import { Meta, Canvas } from '@storybook/blocks'
import TopHeader from '@turistikrota/ui/headers/top'

<Meta title='Components/Headers/Top' />

# Top Header

Top header is used to some contract information and login and register buttons.

Features:

- Left, right and fill slots

<Canvas>
<TopHeader className='hidden md:flex'>
<TopHeader.Left>
<span className='dark:text-white'>some promotion text</span>
</TopHeader.Left>
<TopHeader.Right>
<span className='dark:text-white'>your some link</span>
</TopHeader.Right>
</TopHeader>
</Canvas>

## Usage

```js
Expand Down
18 changes: 17 additions & 1 deletion apps/docs/src/stories/pages/error/ErrorPage.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
import { Meta } from '@storybook/blocks'
import { Meta, Canvas } from '@storybook/blocks'
import ErrorPage from '@turistikrota/ui/pages/error'
import Button from '@turistikrota/ui/button'

<Meta title='Pages/Error' />

# Error Page

Error page is used to display error messages to the user.

## The Overview

<Canvas>
<ErrorPage
title='Not Found'
subtitle='The page you are looking for does not exist.'
button={
<Button className='inline-flex justify-center text-white bg-primary-600 hover:bg-primary-800 focus:ring-4 focus:outline-none focus:ring-primary-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:focus:ring-primary-900 my-4'>
Go to Home
</Button>
}
/>
</Canvas>

## As Not Found (404)

Not found page is used to display 404 error message to the user.
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@turistikrota/ui",
"version": "0.1.0",
"version": "0.1.1",
"description": "the turistikrota ui library for React",
"main": "./cjs/index.js",
"module": "./index.js",
Expand Down

0 comments on commit f2c635e

Please sign in to comment.