@pikacss/plugin-reset 0.0.40 → 0.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +5 -5
  2. package/README.md +0 -145
package/package.json CHANGED
@@ -4,16 +4,16 @@
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
7
- "version": "0.0.40",
7
+ "version": "0.0.41",
8
8
  "author": "DevilTea <ch19980814@gmail.com>",
9
9
  "license": "MIT",
10
10
  "repository": {
11
11
  "type": "git",
12
- "url": "https://github.com/pikacss/pikacss.github.io.git",
12
+ "url": "https://github.com/pikacss/pikacss.git",
13
13
  "directory": "packages/plugin-reset"
14
14
  },
15
15
  "bugs": {
16
- "url": "https://github.com/pikacss/pikacss.github.io/issues"
16
+ "url": "https://github.com/pikacss/pikacss/issues"
17
17
  },
18
18
  "keywords": [
19
19
  "pikacss",
@@ -39,10 +39,10 @@
39
39
  "dist"
40
40
  ],
41
41
  "peerDependencies": {
42
- "@pikacss/core": "0.0.40"
42
+ "@pikacss/core": "0.0.41"
43
43
  },
44
44
  "devDependencies": {
45
- "@pikacss/core": "0.0.40"
45
+ "@pikacss/core": "0.0.41"
46
46
  },
47
47
  "scripts": {
48
48
  "build": "tsdown",
package/README.md DELETED
@@ -1,145 +0,0 @@
1
- <!-- eslint-disable -->
2
- # @pikacss/plugin-reset
3
-
4
- CSS reset/normalize plugin for PikaCSS.
5
-
6
- ## Installation
7
-
8
- ```bash
9
- pnpm add @pikacss/plugin-reset
10
- ```
11
-
12
- ## Quick Start
13
-
14
- **pika.config.ts**:
15
- ```typescript
16
- /// <reference path="./src/pika.gen.ts" />
17
-
18
- import { defineEngineConfig } from '@pikacss/core'
19
- import { reset } from '@pikacss/plugin-reset'
20
-
21
- export default defineEngineConfig({
22
- plugins: [
23
- reset()
24
- ],
25
- // Choose which reset style to use
26
- reset: 'modern-normalize' // default
27
- })
28
- ```
29
-
30
- ## Features
31
-
32
- - 🎨 Multiple popular CSS reset/normalize styles to choose from
33
- - 🔧 Easy to switch between different reset styles
34
- - 📦 Zero dependencies (except @pikacss/core)
35
- - ⚡ Minimal configuration needed
36
- - 🌐 Battle-tested reset styles from the community
37
-
38
- ## Usage
39
-
40
- ### Available Reset Styles
41
-
42
- The plugin includes 5 popular CSS reset/normalize styles:
43
-
44
- 1. **`modern-normalize`** (default) - Modern browser normalization
45
- 2. **`normalize`** - The classic normalize.css
46
- 3. **`andy-bell`** - Andy Bell's Modern CSS Reset
47
- 4. **`eric-meyer`** - Eric Meyer's CSS Reset
48
- 5. **`the-new-css-reset`** - Elad Shechter's The New CSS Reset
49
-
50
- ### Basic Usage
51
-
52
- Apply the default reset (modern-normalize):
53
-
54
- ```typescript
55
- /// <reference path="./src/pika.gen.ts" />
56
-
57
- import { defineEngineConfig } from '@pikacss/core'
58
- import { reset } from '@pikacss/plugin-reset'
59
-
60
- export default defineEngineConfig({
61
- plugins: [
62
- reset()
63
- ]
64
- })
65
- ```
66
-
67
- ### Choose a Different Reset Style
68
-
69
- Select your preferred reset style using the `reset` config option:
70
-
71
- ```typescript
72
- /// <reference path="./src/pika.gen.ts" />
73
-
74
- import { defineEngineConfig } from '@pikacss/core'
75
- import { reset } from '@pikacss/plugin-reset'
76
-
77
- export default defineEngineConfig({
78
- plugins: [
79
- reset()
80
- ],
81
- // Options: 'modern-normalize' | 'normalize' | 'andy-bell' | 'eric-meyer' | 'the-new-css-reset'
82
- reset: 'andy-bell'
83
- })
84
- ```
85
-
86
- ## Reset Styles Comparison
87
-
88
- - **modern-normalize**: Focuses on normalizing only necessary styles for modern browsers
89
- - **normalize**: The classic normalize.css - makes browsers render elements more consistently
90
- - **andy-bell**: A modern, minimal reset focusing on sensible defaults
91
- - **eric-meyer**: The famous CSS reset by Eric Meyer - strips most default styling
92
- - **the-new-css-reset**: An aggressive reset for a clean slate
93
-
94
- ## Configuration
95
-
96
- The reset style is configured at the engine level:
97
-
98
- ```typescript
99
- export default defineEngineConfig({
100
- plugins: [reset()],
101
- reset: 'modern-normalize' // default
102
- })
103
- ```
104
-
105
- ## TypeScript Module Augmentation
106
-
107
- This plugin extends the `EngineConfig` interface from `@pikacss/core` to add the `reset` configuration option. This is done through TypeScript declaration merging:
108
-
109
- ```typescript
110
- // Declared in @pikacss/plugin-reset source
111
- declare module '@pikacss/core' {
112
- interface EngineConfig {
113
- /**
114
- * Reset style to use.
115
- *
116
- * @default 'modern-normalize'
117
- */
118
- reset?: ResetStyle
119
- }
120
- }
121
- ```
122
-
123
- When you import and register the plugin, TypeScript automatically recognizes the `reset` property on your config object, providing autocomplete and type checking:
124
-
125
- ```typescript
126
- import { defineEngineConfig } from '@pikacss/core'
127
- import { reset } from '@pikacss/plugin-reset'
128
-
129
- export default defineEngineConfig({
130
- plugins: [reset()],
131
- // TypeScript provides autocomplete for valid reset values
132
- reset: 'normalize' // ✅ Type-safe: only valid ResetStyle values accepted
133
- // reset: 'invalid' // ❌ TypeScript error: not assignable to type ResetStyle
134
- })
135
- ```
136
-
137
- This module augmentation pattern is used by all official PikaCSS plugins to extend the core configuration interface.
138
-
139
- ## Documentation
140
-
141
- For complete documentation, visit: [PikaCSS Documentation](https://pikacss.github.io/pikacss/)
142
-
143
- ## License
144
-
145
- MIT © DevilTea