@core_super_app/ui 0.0.1 → 0.0.2

package/README.md

@@ -1,37 +1,176 @@
-# @core/ui
+# @core_super_app/ui
 
-Define common components for project
+Thư viện UI component dùng chung cho ứng dụng React Native trong hệ sinh thái Super App.
 
-## Installation
+## Tinh nang
 
+- `BaseView`: layout khung trang + header + loading overlay
+- `Header`: header co nut back, title/subtitle, right view
+- `LoadingOverlay`: overlay loading toan man hinh
+- `TextWrapper`: wrapper cho `Text` voi default style va accessibility
+- `BasicButton`: button gradient co trang thai disabled
+- `BasicInput`: input label dong, clear button, counter, imperative ref
+- Export sang `ImageSrc` cho cac asset icon
 
-```sh
-npm install @core/ui
+## Cai dat
+
+```bash
+npm install @core_super_app/ui
+```
+
+hoac
+
+```bash
+yarn add @core_super_app/ui
+```
+
+## Yeu cau
+
+- Node.js `v22.20.0` (xem `.nvmrc`)
+- React Native `0.84.x`
+- Peer ecosystem su dung trong source:
+  - `react-native-reanimated`
+  - `react-native-linear-gradient`
+  - `@react-navigation/native`
+  - `@core_super_app/utils`
+
+## Cac export chinh
+
+Tu root package:
+
+```ts
+import {
+  BaseView,
+  Header,
+  LoadingOverlay,
+  TextWrapper,
+  BasicButton,
+  BasicInput,
+  ImageSrc,
+} from '@core_super_app/ui';
 ```
 
+`src/index.tsx` hien tai export:
 
-## Usage
+- toan bo trong `components`
+- namespace `ImageSrc` tu `constants/image`
 
+## Vi du su dung
 
-```js
-import { multiply } from '@core/ui';
+### `BasicButton`
 
-// ...
+```tsx
+import { BasicButton } from '@core_super_app/ui';
 
-const result = multiply(3, 7);
+<BasicButton onPress={() => console.log('pressed')}>
+  Dang nhap
+</BasicButton>;
 ```
 
+### `BasicInput` voi ref
+
+```tsx
+import { useRef } from 'react';
+import { BasicInput } from '@core_super_app/ui';
+
+type InputRef = {
+  focus: () => void;
+  blur: () => void;
+};
+
+const inputRef = useRef<InputRef>(null);
+
+<BasicInput
+  ref={inputRef}
+  label="So dien thoai"
+  value={phone}
+  onChange={setPhone}
+  showClearButton
+/>;
+```
+
+### `BaseView`
+
+```tsx
+import { BaseView } from '@core_super_app/ui';
+
+<BaseView
+  isLoading={loading}
+  back
+  title="Thong tin ca nhan"
+>
+  {/* Screen content */}
+</BaseView>;
+```
+
+## API tong quan
+
+### Components
+
+- `BaseView`
+  - Props gom:
+    - `background`
+    - toan bo `HeaderProps`
+    - toan bo `LoadingOverlayProps`
+- `Header`
+  - Props chinh:
+    - `back`, `leftIcon`, `onPressLeftIcon`
+    - `title`, `subTitle`, `titleStyle`, `titleMaxLines`
+    - `rightView`
+    - `disabledBackHandler`
+- `LoadingOverlay`
+  - `isLoading?: boolean`
+  - `indicatorColor?: string`
+- `TextWrapper`
+  - `children`, `style`, `numberOfLines`, `ellipsizeMode`, `onPress`, `testID`
+- `BasicButton`
+  - `onPress`, `disabled`, `colors`, `style`, `textStyle`, `children`
+- `BasicInput`
+  - Ho tro label animation, clear icon, char counter, regex replace input
+  - Ho tro imperative ref: `focus()` va `blur()`
+
+## Scripts
+
+Trong `package.json`:
+
+- `yarn clean` - xoa build artifacts
+- `yarn prepare` - build package bang `react-native-builder-bob`
+- `yarn typecheck` - kiem tra TypeScript
+- `yarn lint` - lint source
+- `yarn test` - chay Jest
+- `yarn release` - bump version/publish qua `release-it`
+
+## CI
+
+GitHub Actions (`.github/workflows/ci.yml`) dang chay:
+
+- lint + typecheck
+- unit test (coverage)
+- build library
+- build Android example (co turbo cache)
+- build iOS example (co turbo cache)
+
+## Publishing
+
+Package publish public len npm:
+
+- `publishConfig.access = public`
+- release command:
+
+```bash
+yarn release
+```
+
+Release flow su dung `release-it` + conventional changelog + git tag `v<version>`.
 
 ## Contributing
 
-- [Development workflow](CONTRIBUTING.md#development-workflow)
-- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
-- [Code of conduct](CODE_OF_CONDUCT.md)
+- [Development workflow](./CONTRIBUTING.md#development-workflow)
+- [Sending a pull request](./CONTRIBUTING.md#sending-a-pull-request)
+- [Code of conduct](./CODE_OF_CONDUCT.md)
+
+Commit message convention theo [Conventional Commits](https://www.conventionalcommits.org/).
 
 ## License
 
 MIT
-
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/lib/module/components/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sourceRoot":"..\\..\\..\\src","sources":["components/index.ts"],"mappings":";;AAAA,cAAc,eAAY;AAC1B,cAAc,aAAU;AACxB,cAAc,qBAAkB;AAChC,cAAc,kBAAe;AAC7B,cAAc,kBAAS;AACvB,cAAc,kBAAe","ignoreList":[]}
+{"version":3,"names":[],"sourceRoot":"..\\..\\..\\src","sources":["components/index.tsx"],"mappings":";;AAAA,cAAc,eAAY;AAC1B,cAAc,aAAU;AACxB,cAAc,qBAAkB;AAChC,cAAc,kBAAe;AAC7B,cAAc,kBAAS;AACvB,cAAc,kBAAe","ignoreList":[]}

package/lib/typescript/src/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.tsx"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@core_super_app/ui",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Define common components for project",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -37,7 +37,6 @@
     "!**/.*"
   ],
   "scripts": {
-    "example": "yarn workspace @core/ui-example",
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
     "prepare": "bob build",
     "typecheck": "tsc",