Skip to content

Commit d0bee42

Browse files
committed
feat: docs changes
1 parent 11459a6 commit d0bee42

File tree

9 files changed

+24
-17
lines changed

9 files changed

+24
-17
lines changed

example/storybook-nativewind/src/apps/dashboard-app/index.stories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dashboard App | gluestack-ui
3-
description: A dashboard app created using all the components of gluestack-ui styled with NativeWind
3+
description: A dashboard app created using all the components of gluestack-ui v2
44
toc: false
55
---
66

@@ -12,7 +12,7 @@ import { kitchensink } from '../../extra-components/nativewind/appConfig';
1212

1313
# Dashboard App
1414

15-
This [Dashboard App](https://ui-example-nativewind.vercel.app/) is built using `gluestack-ui` components styled with `NativeWind`.
15+
This [Dashboard App](https://ui-example-nativewind.vercel.app/) is built using `gluestack-ui v2`.
1616

1717
<Responsiveness {...kitchensink} showMenuItems={true} />
1818

example/storybook-nativewind/src/apps/starter-kit/index.stories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Starter Kit | gluestack-ui
3-
description: A starter kit created using all the components of gluestack-ui styled with NativeWind
3+
description: A starter kit created using all the components of gluestack-ui v2
44
toc: false
55
---
66

@@ -12,7 +12,7 @@ import { starterKit } from '../../extra-components/nativewind/appConfig';
1212

1313
# Starter Kit
1414

15-
This [Starter Kit](https://gluestack-ui-starter-kits.vercel.app/) is built using `gluestack-ui` components styled with `NativeWind`.
15+
This [Starter Kit](https://gluestack-ui-starter-kits.vercel.app/) is built using `gluestack-ui v2`.
1616

1717
<Responsiveness {...starterKit} />
1818

example/storybook-nativewind/src/apps/storybook-app/index.stories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Storybook App | gluestack-ui
3-
description: A storybook app created using all the components of gluestack-ui styled with NativeWind
3+
description: A storybook app created using all the components of gluestack-ui v2
44
toc: false
55
---
66

@@ -12,6 +12,6 @@ import { appStoryConfig } from '../../extra-components/nativewind/appConfig';
1212

1313
# Storybook App
1414

15-
This is a [Storybook App](https://storybook-v2.gluestack.io/?path=/story/stories-accordion--accordion) of `gluestack-ui` components styled with `NativeWind`.
15+
This is a [Storybook App](https://storybook-v2.gluestack.io/?path=/story/stories-accordion--accordion) of `gluestack-ui v2`.
1616

1717
<Responsiveness {...appStoryConfig} />

example/storybook-nativewind/src/home/getting-started/cli/index.nw.stories.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ The gluestack-ui CLI is a tool that simplifies integrating the gluestack-ui into
1717

1818
Use init command to set up your project.
1919

20-
The init command adds the necessary `gluestack-ui.config.json` file, includes the `GluestackUIProvider`, installs dependencies, and configures `metro.config.js`, `babel.config.js`, `next.config.js` ( for Next.js) and `tailwind.config.js` for your project.
20+
The init command adds the necessary `gluestack-ui.config.json` file, includes the `GluestackUIProvider`, installs dependencies, and configures above files for your project.
21+
- `metro.config.js`
22+
- `babel.config.js`
23+
- `next.config.js` ( for Next.js)
24+
- `tailwind.config.js`
25+
- `global.css` (for Tailwind CSS)
26+
- entry file (for your project)
27+
2128

2229
```bash
2330
npx gluestack-ui init

example/storybook-nativewind/src/home/getting-started/figma-ui-kit/index.nw.stories.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';
99

1010
# Figma UI Kit
1111

12-
The [Figma UI Kit](https://www.figma.com/@gluestack) provides a collection of ready-to-use UI components from the gluestack-ui library. So you can directly use these components in Figma and design your app. The developers won’t have a chance to say this is not possible!
12+
The [Figma UI Kit](https://www.figma.com/@gluestack) provides a collection of ready-to-use UI components from the gluestack-ui v2. So you can directly use these components in Figma and design your app. The developers won’t have a chance to say this is not possible!
1313

1414
## Auto-generated
1515

example/storybook-nativewind/src/home/getting-started/vscode-extensions/index.nw.stories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Canvas, Meta, Story } from '@storybook/addon-docs';
99

1010
# VS Code Extensions
1111

12-
[gluestack VS Code Extension](https://marketplace.visualstudio.com/items?itemName=gluestack.gluestack-vscode) is specially crafted to streamline your development process when using the `@gluestack-ui with nativewind` library. It provides a set of powerful features to accelerate your workflow and improve efficiency.
12+
[gluestack VS Code Extension](https://marketplace.visualstudio.com/items?itemName=gluestack.gluestack-vscode) is specially crafted to streamline your development process when using the gluestack-ui v2. It provides a set of powerful features to accelerate your workflow and improve efficiency.
1313
These extensions provide gluestack snippets, which are shorthand for commonly used gluestack-ui components.
1414
All snippets start with the prefix `gs-` and are followed by the name of the desired component.
1515

@@ -43,7 +43,7 @@ Tailor your application's functionality specific requirements using dynamic hook
4343
To get started with the gluestack VS Code Extension, follow these steps:
4444

4545
1. Install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=gluestack.gluestack-vscode).
46-
2. Open a project in Visual Studio Code that uses `gluestack-ui` library.
46+
2. Open a project in Visual Studio Code that uses `gluestack-ui v2`.
4747
3. Start using the extension by accessing the snippets, recipes, and automatic import features described above.
4848

4949
## Example Usage

example/storybook-nativewind/src/home/theme-configuration/customizing-theme/index.nw.stories.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Customizing Theme
33

4-
description: Customizing the theme in gluestack-ui with nativewind involves defining a theme configuration and applying it using GluestackUIProvider, enabling you to style your application's visual elements according to your design preferences.
4+
description: Customizing the theme in gluestack-ui v2 involves defining a theme configuration and applying it using GluestackUIProvider, enabling you to style your application's visual elements according to your design preferences.
55

66
showHeader: true
77
---
@@ -14,9 +14,9 @@ import { CollapsibleCode } from '@gluestack/design-system';
1414

1515
## Customizing Tokens
1616

17-
gluestack-ui, integrated with Nativewind, seamlessly accommodates the default Tailwind CSS [theme](https://tailwindcss.com/docs/theme), allowing users to effortlessly expand and customize it to suit their needs.
17+
gluestack-ui v2, seamlessly accommodates the default Tailwind CSS [theme](https://tailwindcss.com/docs/theme), allowing users to effortlessly expand and customize it to suit their needs.
1818

19-
gluestack-ui with nativewind also ships with a set of handpicked default color palette tokens which are mapped separately with each mode. For example, the default color palette for light mode is `light` and the default color palette for dark mode is `dark`.
19+
gluestack-ui v2 also ships with a set of handpicked default color palette tokens which are mapped separately with each mode. For example, the default color palette for light mode is `light` and the default color palette for dark mode is `dark`.
2020

2121
To customize tokens, follow these steps:
2222

example/storybook-nativewind/src/home/theme-configuration/dark-mode/index.nw.stories.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Dark Mode
33

4-
description: Customizing the theme in gluestack-ui with NativeWind for different color schemes and color mode support.
4+
description: Customizing the theme in gluestack-ui v2 for different color schemes and color mode support.
55

66
showHeader: true
77
---

example/storybook-nativewind/src/home/theme-configuration/default-tokens/index.nw.stories.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Default Tokens | gluestack-ui
33

4-
description: gluestack-ui with nativewind ships with default tokens that provide access to theme values and lets you build and customize your own themed components.
4+
description: gluestack-ui v2 ships with default tokens that provide access to theme values and lets you build and customize your own themed components.
55

66
pageTitle: Default Tokens
77

8-
pageDescription: gluestack-ui with nativewind ships with default tokens that provide access to theme values and lets you build and customize your own themed components.
8+
pageDescription: gluestack-ui v2 ships with default tokens that provide access to theme values and lets you build and customize your own themed components.
99

1010
showHeader: true
1111
---
@@ -15,7 +15,7 @@ import {ColorPaletteComponent, ShadowComponent, FontSizeComponent, FontWeightCom
1515

1616
<Meta title="with-nativewind/Home/Theme Configuration/Default Tokens" />
1717

18-
Theming in `@gluestack-ui with nativewind` is based on the [Styled System Theme Specification](https://github.com/system-ui/theme-specification).
18+
Theming in `@gluestack-ui v2` is based on the [Styled System Theme Specification](https://github.com/system-ui/theme-specification).
1919

2020
## Colors
2121

0 commit comments

Comments
 (0)