Skip to content

Commit 130dfed

Browse files
alstn113alstn113
committed
refactor: change pkg name to wap-ui
1 parent 320eb87 commit 130dfed

28 files changed

+2387
-2261
lines changed

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
<a href="https://github.com/pknu-wap/wap-ui/blob/main/LICENSE">
88
<img src="https://badgen.net/github/license/pknu-wap/wap-ui">
99
</a>
10-
<a href="https://www.npmjs.com/package/@wap-ui/react">
11-
<img src="https://img.shields.io/npm/dm/@wap-ui/react.svg?style=flat-round" alt="npm downloads">
10+
<a href="https://www.npmjs.com/package/wap-ui">
11+
<img src="https://img.shields.io/npm/dm/wap-ui.svg?style=flat-round" alt="npm downloads">
1212
</a>
1313
<img alt="Github Stars" src="https://badgen.net/github/stars/pknu-wap/wap-ui" />
1414
<img src="https://badgen.net/github/release/pknu-wap/wap-ui">
@@ -41,30 +41,30 @@
4141

4242
## `Installing WAP-UI`
4343

44-
To use WAP UI, Install the `@wap-ui/react` package and its peer dependencies.
44+
To use WAP UI, Install the `wap-ui` package and its peer dependencies.
4545
(`@emotion/react`, `@emotion/styled`, `framer-motion`)
4646

4747
```sh
48-
pnpm add @wap-ui/react @emotion/react @emotion/styled framer-motion
48+
pnpm add wap-ui @emotion/react @emotion/styled framer-motion
4949
# or
50-
yarn add @wap-ui/react @emotion/react @emotion/styled framer-motion
50+
yarn add wap-ui @emotion/react @emotion/styled framer-motion
5151
# or
52-
npm i @wap-ui/react @emotion/react @emotion/styled framer-motion
52+
npm i wap-ui @emotion/react @emotion/styled framer-motion
5353
```
5454

5555
## `Usage`
5656

5757
To start using the components, follow these steps:
5858

59-
1. For WAP UI to work correctly, Wrap `WapUIProvider` provided by `@wap-ui/react` at root of your application.
59+
1. For WAP UI to work correctly, Wrap `WapUIProvider` provided by `wap-ui` at root of your application.
6060

6161
```tsx
6262
import React from 'react';
6363

6464
// 1. import `WapUIProvider` component
6565
import ReactDOM from 'react-dom/client';
6666
import App from './App';
67-
import { WapUIProvider } from '@wap-ui/react';
67+
import { WapUIProvider } from 'wap-ui';
6868

6969
// 2. Wrap WapUIProvider at the root of your app
7070
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
@@ -77,7 +77,7 @@ ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
7777
2. Bring components what you want and use them.
7878

7979
```tsx
80-
import { Button } from '@wap-ui/react';
80+
import { Button } from 'wap-ui';
8181

8282
const Home = () => {
8383
return (
@@ -143,7 +143,7 @@ export default Home;
143143
## `Links`
144144

145145
- #### [Documents](https://github.com/pknu-wap/wap-ui/tree/main/docs)
146-
- #### [NPM](https://www.npmjs.com/package/@wap-ui/react)
146+
- #### [NPM](https://www.npmjs.com/package/wap-ui)
147147
- #### [Playground](https://wap-ui.vercel.app/)
148148
- #### [Presentations](https://github.com/pknu-wap/wap-ui/tree/main/ppt)
149149
- #### [Example](https://github.com/pknu-wap/wap-ui/tree/main/example)

‎docs/components/Accordion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ interface AccordionItemProps {
3333
## `example`
3434

3535
```tsx
36-
import { Accordion } from '@wap-ui/react';
36+
import { Accordion } from 'wap-ui';
3737

3838
const App = () => {
3939
return (

‎docs/components/Button.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ interface ButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
1414
## `example`
1515

1616
```tsx
17-
import { Button } from '@wap-ui/react';
17+
import { Button } from 'wap-ui';
1818

1919
const App = () => {
2020
return (

‎docs/components/Card.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ interface CardProps {
1313
## `example`
1414

1515
```tsx
16-
import { Card } from '@wap-ui/react';
16+
import { Card } from 'wap-ui';
1717

1818
const App = () => {
1919
return (

‎docs/components/Checkbox.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ interface CheckboxProps extends InputHTMLAttributes<HTMLInputElement> {
1212
## `example`
1313

1414
```tsx
15-
import { Checkbox } from '@wap-ui/react';
15+
import { Checkbox } from 'wap-ui';
1616

1717
const App = () => {
1818
return (

‎docs/components/Dropdown.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface DropdownButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
2626
## `example`
2727

2828
```tsx
29-
import { Dropdown } from '@wap-ui/react';
29+
import { Dropdown } from 'wap-ui';
3030

3131
const App = () => {
3232
return (

‎docs/components/Loader.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
## `example`
2121

2222
```tsx
23-
import { Loader } from '@wap-ui/react';
23+
import { Loader } from 'wap-ui';
2424

2525
const App = () => {
2626
return (

‎docs/components/Modal.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ type ModalFooterProps = React.DetailedHTMLProps<
4343
## `example`
4444

4545
```tsx
46-
import { Modal, Button, useDisclosure } from '@wap-ui/react';
46+
import { Modal, Button, useDisclosure } from 'wap-ui';
4747
import styled from '@emotion/styled';
4848

4949
const App = () => {

‎docs/components/Radio.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ interface RadioProps extends InputHTMLAttributes<HTMLInputElement> {
1313
## `example`
1414

1515
```tsx
16-
import { Radio } from '@wap-ui/react';
16+
import { Radio } from 'wap-ui';
1717

1818
const App = () => {
1919
return (

‎docs/components/ScrollToTop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ScrollToTop이 사용된 컴포넌트가 렌더링될 때 스크롤이 최상단
77
## `example`
88

99
```tsx
10-
import { ScrollToTop } from '@wap-ui/react';
10+
import { ScrollToTop } from 'wap-ui';
1111

1212
const App = () => {
1313
return (

‎docs/components/Textinput.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ interface TextInputProps extends InputHTMLAttributes<HTMLInputElement> {
1313
## `example`
1414

1515
```tsx
16-
import { TextInput } from '@wap-ui/react';
16+
import { TextInput } from 'wap-ui';
1717

1818
const App = () => {
1919
return (

‎docs/components/Toast.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ type ToastPosition =
2929
## `example`
3030

3131
```tsx
32-
import { useToast, Toaster } from '@wap-ui/react';
32+
import { useToast, Toaster } from 'wap-ui';
3333

3434
const App = () => {
3535
const { toast } = useToast();

‎docs/components/Toggle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ type NormalColorType =
2020
## `example`
2121

2222
```tsx
23-
import { Toggle } from '@wap-ui/react';
23+
import { Toggle } from 'wap-ui';
2424

2525
const App = () => {
2626
return (

‎docs/components/Tooltip.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface TooltipProps {
1515
## `example`
1616

1717
```tsx
18-
import { Tooltip } from '@wap-ui/react';
18+
import { Tooltip } from 'wap-ui';
1919

2020
const App = () => {
2121
return (

‎docs/hooks/useDebounce.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface Props<T> {
1919

2020
```tsx
2121
import { useState } from 'react';
22-
import { useDebounce, TextInput } from '@wap-ui/react';
22+
import { useDebounce, TextInput } from 'wap-ui';
2323

2424
const App = () => {
2525
const [searchText, setSearchText] = useState<string>('');

‎docs/hooks/useDidMountEffect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface Props {
1818

1919
```tsx
2020
import { useState } from 'react';
21-
import { useDidMountEffect } from '@wap-ui/react';
21+
import { useDidMountEffect } from 'wap-ui';
2222

2323
const App = () => {
2424
const [count, setCount] = useState<number>(0);

‎docs/hooks/useDisclosure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ interface Props {
1515
## `example`
1616

1717
```tsx
18-
import { Modal, useDisclosure } from '@wap-ui/react';
18+
import { Modal, useDisclosure } from 'wap-ui';
1919

2020
const App = () => {
2121
const { isOpen, onOpen, onClose, onToggle } = useDisclosure();

‎docs/hooks/useOnClickOutside.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface Props {
1818

1919
```tsx
2020
import { useRef } from 'react'
21-
import { useOnClickOutside } from '@wap-ui/react'
21+
import { useOnClickOutside } from 'wap-ui'
2222

2323
const App = () => {
2424
const ref = useRef(null);

‎docs/hooks/useThrottle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface Props<T> {
1919

2020
```tsx
2121
import { useState } from 'react';
22-
import { useThrottle, TextInput } from '@wap-ui/react';
22+
import { useThrottle, TextInput } from 'wap-ui';
2323

2424
const App = () => {
2525
const [searchText, setSearchText] = useState<string>('');

‎docs/layouts/Spacer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ interface Spacer {
1212
## `example`
1313

1414
```tsx
15-
import { Spacer } from '@wap-ui/react'
15+
import { Spacer } from 'wap-ui'
1616
import { styled } from '@emotion/react'
1717

1818
const App = () => {

‎example/react-ts/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"dependencies": {
1212
"@emotion/react": "^11.10.5",
1313
"@emotion/styled": "^11.10.5",
14-
"@wap-ui/react": "^2.0.0",
14+
"wap-ui": "^2.0.2",
1515
"framer-motion": "^7.6.15",
1616
"react": "^18.2.0",
1717
"react-dom": "^18.2.0"

‎example/react-ts/src/App.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import dancingCat from './assets/dancing-cat.gif';
22
import styled from '@emotion/styled';
3-
import { Button, Modal, Tooltip, useDisclosure } from '@wap-ui/react';
3+
import { Button, Modal, Tooltip, useDisclosure } from 'wap-ui';
44

55
function App() {
66
const { isOpen, onClose, onOpen } = useDisclosure();

‎example/react-ts/src/main.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import ReactDOM from 'react-dom/client';
2-
import { WapUIProvider } from '@wap-ui/react';
2+
import { WapUIProvider } from 'wap-ui';
33
import App from './App';
44

55
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(

0 commit comments

Comments
 (0)