Skip to content

Commit

Permalink
fix: Fixed type export issue and broken expo snacks in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
agrawal-rohit committed Dec 17, 2023
1 parent 92a72bb commit 9ee0b02
Show file tree
Hide file tree
Showing 21 changed files with 39 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/docs/components/feedback/Badge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The `Badge` component supports a [variety of style props](#supported-style-props

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/badge-light" />
<Snack snackId="@agrawal-rohit/badge" />

## Badge Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/feedback/Skeleton.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The `Skeleton` component supports a variety of style props which can be used to

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/skeleton-light" />
<Snack snackId="@agrawal-rohit/skeleton" />

## Skeleton Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/feedback/Spinner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The `Spinner` component supports a [variety of style props](#supported-style-pro

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/spinner-light" />
<Snack snackId="@agrawal-rohit/spinner" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/Button.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The `Button` component supports a [variety of style props](#supported-style-prop

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/button-light" />
<Snack snackId="@agrawal-rohit/button" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/CheckBox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ The `CheckBox` component supports a [variety of style props](#supported-style-pr

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/checkbox-light" />
<Snack snackId="@agrawal-rohit/checkbox" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/Input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The `Input` component supports a variety of style props which can be used to ove

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/input-light" />
<Snack snackId="@agrawal-rohit/input" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/Pressable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The `Pressable` component allows you to customize the appearance of the componen

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/pressable-light" />
<Snack snackId="@agrawal-rohit/pressable" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/Radio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ You can override the default styles of the `Radio` component by passing style pr

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/radio-light" />
<Snack snackId="@agrawal-rohit/radio" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/forms/Textarea.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The `Textarea` component supports a variety of style props which can be used to

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/textarea-light" />
<Snack snackId="@agrawal-rohit/textarea" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/layout/Divider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The `Divider` component supports a variety of style props which can be used to o

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/divider-light" />
<Snack snackId="@agrawal-rohit/divider" />

## Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/layout/Screen.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Here are examples of the `Screen` component in both light and dark themes:

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/screen-light" />
<Snack snackId="@agrawal-rohit/screen" />

## Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/layout/Spacer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import { Spacer } from "pearl-ui";

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/spacing" />
<Snack snackId="@agrawal-rohit/spacer" />

## Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/layout/Stack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Here are some examples of how you can use the `Stack` components in your project

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/stack-light" />
<Snack snackId="@agrawal-rohit/stack" />

## Stack Component Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/media/Avatar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ The `Avatar` component supports a variety of style props which can be used to ov

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/avatar-light" />
<Snack snackId="@agrawal-rohit/avatar" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/media/Icon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The `Icon` component supports a variety of style props which can be used to over

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/icon-light" />
<Snack snackId="@agrawal-rohit/icon" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/media/Image.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ The `Image` component supports a variety of style props that can be used to over

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/image-light" />
<Snack snackId="@agrawal-rohit/image" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/media/Video.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ The `Video` component supports a variety of style props that can be used to over

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/video-light" />
<Snack snackId="@agrawal-rohit/video" />

## Accessibility

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/typography/Text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The `Text` component supports a wide range of style props that can be used to ov

import Snack from "../../../src/components/ExpoSnack";

<Snack snackId="@agrawal-rohit/text-light" />
<Snack snackId="@agrawal-rohit/text" />

## Accessibility

Expand Down
18 changes: 18 additions & 0 deletions docs/docs/overview/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,26 @@ yarn add pearl-ui
</TabItem>
</Tabs>

## Add the reanimated plugin in the babel configuration

To add the reanimated plugin, modify your `babel.config.js` file as follows:

```jsx
module.exports = function (api) {
api.cache(true);
return {
presets: ["babel-preset-expo"],
plugins: ["react-native-reanimated/plugin"],
};
};
```

## Setting up Pearl UI

:::info
For optimal performance, we recommend using the **"hermes"** JavaScript engine. You may encounter issues with the "jsc" engine.
:::

To get started with Pearl UI, you need to set up the theme provider and load the required fonts. This guide will walk you through the process.

### Setting up the Theme Provider
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,11 @@
"dist/**/*.{js,ts}",
"package.json",
"package-lock.json",
"yarn.lock",
"CHANGELOG.md"
],
"message": "chore(release): ${nextRelease.version} [skip ci]nn${nextRelease.notes}"
}
]
}
}
}
3 changes: 1 addition & 2 deletions src/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ export { baseTheme, extendTheme } from "./src/base/index";
export { generatePalette } from "./utils/utils";

// Types
export type * from "./src/types";
export type * from "./src/style-functions";
export * from "./src/types";

1 comment on commit 9ee0b02

@vercel
Copy link

@vercel vercel bot commented on 9ee0b02 Dec 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

pearl-ui – ./

pearl-ui-git-main-rohit9009.vercel.app
pearl-ui-rohit9009.vercel.app
docs.pearl-ui.dev

Please sign in to comment.