@pikas-ui/text - npm Package Compare versions

Comparing version 1.0.25 to 1.0.26

dist/description/Description.d.ts

@@ -0,0 +0,0 @@ import { CSS } from '@pikas-ui/styles';

dist/label/Label.d.ts

@@ -0,0 +0,0 @@ import { CSS } from '@pikas-ui/styles';

dist/textError/TextError.d.ts

@@ -0,0 +0,0 @@ import { CSS } from '@pikas-ui/styles';

package.json

 {
   "name": "@pikas-ui/text",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "private": false,
@@ -13,9 +13,2 @@ "description": "",
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "format": "prettier --write \"**/*.{ts,tsx}\"",
-    "lint": "cross-env TIMING=1 eslint src --fix",
-    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
-  },
   "repository": {
@@ -40,4 +33,4 @@ "type": "git",
   "devDependencies": {
-    "@pikas-ui/config": "workspace:*",
-    "@pikas-ui/tsconfig": "workspace:*",
+    "@pikas-ui/config": "0.0.0",
+    "@pikas-ui/tsconfig": "0.0.0",
     "@types/node": "^17.0.38",
@@ -50,3 +43,10 @@ "@types/react": "^18.0.10",
   },
-  "node": "12.20.0 || 14.13.1 || >=16.0.0"
-}
+  "node": "12.20.0 || 14.13.1 || >=16.0.0",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "format": "prettier --write \"**/*.{ts,tsx}\"",
+    "lint": "cross-env TIMING=1 eslint src --fix",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+  }
+}

README.md

@@ -31,3 +31,60 @@ # @pikas-ui/text
 
+## Usage
+
+### Label
+```tsx
+import { Label } from `@pikas-ui/text`;
+
+const Example: React.FC = () => {
+  return <Label>Label</Label>
+}
+```
+
+#### Props
+
+| Prop       | Description             | Type              | Default |
+| :--------- | :---------------------- | :---------------- | :------ |
+| `htmlFor`  | The id of the label.    | `string`          | -       |
+| `style`    | The style of the label. | `CSS`             | -       |
+| `children` | The text of the label.  | `React.ReactNode` | -       |
+
+---
+
+### Description
+```tsx
+import { Description } from `@pikas-ui/text`;
+
+const Example: React.FC = () => {
+  return <Description>Label</Description>
+}
+```
+
+#### Props
+
+| Prop       | Description                   | Type              | Default |
+| :--------- | :---------------------------- | :---------------- | :------ |
+| `style`    | The style of the description. | `CSS`             | -       |
+| `children` | The text of the description.  | `React.ReactNode` | -       |
+
+---
+
+### TextError
+```tsx
+import { TextError } from `@pikas-ui/text`;
+
+const Example: React.FC = () => {
+  return <TextError>Label</TextError>
+}
+```
+
+#### Props
+
+| Prop       | Description                  | Type              | Default |
+| :--------- | :--------------------------- | :---------------- | :------ |
+| `style`    | The style of the text error. | `CSS`             | -       |
+| `children` | The text of the text error.  | `React.ReactNode` | -       |
+
+---
+
 ### Change Log
 You can find the change log [here](CHANGELOG.md).

No alert changes

Improved metrics

Total package byte prevSize

16640

increased by15.2%

Number of package files

38

increased by2.7%

Number of lines in readme file

89

increased by178.13%

No dependency changes