@sankyu/vue-circle-flags 0.0.2-beta → 0.0.3-beta
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.
- package/README.md +20 -0
- package/README.zh.md +20 -0
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -41,6 +41,9 @@ Perfect for applications that need fast, crisp country flags without external im
|
|
|
41
41
|
|
|
42
42
|
## ✨ Key Features
|
|
43
43
|
|
|
44
|
+
> [!TIP]
|
|
45
|
+
> For more information, you may refer to the [Documentation](https://react-circle-flags.js.org/docs/guides/getting-started/#-key-features).
|
|
46
|
+
|
|
44
47
|
- 🎯 **Tree-shakable** - Only bundle the flags you use
|
|
45
48
|
- 📦 **TypeScript** - Full type definitions included
|
|
46
49
|
- ⚡ **Zero dependencies** - Only requires Vue 3 as peer dependency
|
|
@@ -61,6 +64,9 @@ yarn add @sankyu/vue-circle-flags
|
|
|
61
64
|
bun add @sankyu/vue-circle-flags
|
|
62
65
|
```
|
|
63
66
|
|
|
67
|
+
> [!TIP]
|
|
68
|
+
> For more information, you may refer to the [Installation Guide](https://react-circle-flags.js.org/docs/guides/getting-started/installation/).
|
|
69
|
+
|
|
64
70
|
## 🚀 Usage
|
|
65
71
|
|
|
66
72
|
### Import individual flags (Recommended)
|
|
@@ -120,6 +126,11 @@ const FlagComponent = computed(() => {
|
|
|
120
126
|
</template>
|
|
121
127
|
```
|
|
122
128
|
|
|
129
|
+
### Other usage examples
|
|
130
|
+
|
|
131
|
+
> [!TIP]
|
|
132
|
+
> For more information, you may refer to the [Usage Guide](https://react-circle-flags.js.org/docs/guides/getting-started/usage/).
|
|
133
|
+
|
|
123
134
|
## 📚 API
|
|
124
135
|
|
|
125
136
|
### Props
|
|
@@ -173,6 +184,9 @@ See the [Full list of flags](https://react-circle-flags.js.org/browse) in the ga
|
|
|
173
184
|
|
|
174
185
|
Flag components accept all standard SVG attributes and can be styled using Vue's class and style bindings.
|
|
175
186
|
|
|
187
|
+
> [!TIP]
|
|
188
|
+
> For more information, you may refer to the [Styling Guide](https://react-circle-flags.js.org/docs/guides/getting-started/styling/).
|
|
189
|
+
|
|
176
190
|
```vue
|
|
177
191
|
<script setup lang="ts">
|
|
178
192
|
import { FlagUs } from '@sankyu/vue-circle-flags'
|
|
@@ -194,6 +208,9 @@ import { FlagUs } from '@sankyu/vue-circle-flags'
|
|
|
194
208
|
|
|
195
209
|
All flag components are fully typed with TypeScript, providing autocomplete and type safety out of the box.
|
|
196
210
|
|
|
211
|
+
> [!TIP]
|
|
212
|
+
> For more information, you may refer to the [TypeScript Guide](https://react-circle-flags.js.org/docs/guides/getting-started/typescript/).
|
|
213
|
+
|
|
197
214
|
```typescript
|
|
198
215
|
import type { FlagComponentProps, FlagCode } from '@sankyu/vue-circle-flags'
|
|
199
216
|
|
|
@@ -208,6 +225,9 @@ const invalid: FlagCode = 'xyz' // ✗ Type error
|
|
|
208
225
|
|
|
209
226
|
Importing individual flags ensures that only the used flags are included in your bundle.
|
|
210
227
|
|
|
228
|
+
> [!TIP]
|
|
229
|
+
> For more information, you may refer to the [Bundle Size & Tree-shaking Guide](https://react-circle-flags.js.org/docs/guides/getting-started/bundle-size/).
|
|
230
|
+
|
|
211
231
|
```vue
|
|
212
232
|
<script setup lang="ts">
|
|
213
233
|
// ✓ Good - only FlagUs and FlagCn are bundled
|
package/README.zh.md
CHANGED
|
@@ -41,6 +41,9 @@
|
|
|
41
41
|
|
|
42
42
|
## ✨ 核心特性
|
|
43
43
|
|
|
44
|
+
> [!TIP]
|
|
45
|
+
> 欲了解更多信息,请参阅 [文档](https://react-circle-flags.js.org/docs/guides/getting-started/#-key-features)。
|
|
46
|
+
|
|
44
47
|
- 🎯 **支持 Tree-shaking 优化** - 仅打包您使用的国旗
|
|
45
48
|
- 📦 **TypeScript** - 包含完整的类型定义
|
|
46
49
|
- ⚡ **零依赖** - 仅需 Vue 3 作为对等依赖
|
|
@@ -61,6 +64,9 @@ yarn add @sankyu/vue-circle-flags
|
|
|
61
64
|
bun add @sankyu/vue-circle-flags
|
|
62
65
|
```
|
|
63
66
|
|
|
67
|
+
> [!TIP]
|
|
68
|
+
> 欲了解更多信息,请参阅 [安装指南](https://react-circle-flags.js.org/docs/guides/getting-started/installation/)。
|
|
69
|
+
|
|
64
70
|
## 🚀 使用
|
|
65
71
|
|
|
66
72
|
### 导入单个国旗(推荐)
|
|
@@ -120,6 +126,11 @@ const FlagComponent = computed(() => {
|
|
|
120
126
|
</template>
|
|
121
127
|
```
|
|
122
128
|
|
|
129
|
+
### 其他使用示例
|
|
130
|
+
|
|
131
|
+
> [!TIP]
|
|
132
|
+
> 欲了解更多信息,请参阅 [使用指南](https://react-circle-flags.js.org/docs/guides/getting-started/usage/)。
|
|
133
|
+
|
|
123
134
|
## 📚 API
|
|
124
135
|
|
|
125
136
|
### 属性
|
|
@@ -173,6 +184,9 @@ console.log(buildMeta.circleFlagsCommitHash) // 例如:<示例-sha256-哈希
|
|
|
173
184
|
|
|
174
185
|
国旗组件接受所有标准 SVG 属性,可使用 Vue 的 class 和 style 绑定轻松设置样式。
|
|
175
186
|
|
|
187
|
+
> [!TIP]
|
|
188
|
+
> 欲了解更多信息,请参阅 [样式指南](https://react-circle-flags.js.org/docs/guides/getting-started/styling/)。
|
|
189
|
+
|
|
176
190
|
```vue
|
|
177
191
|
<script setup lang="ts">
|
|
178
192
|
import { FlagUs } from '@sankyu/vue-circle-flags'
|
|
@@ -194,6 +208,9 @@ import { FlagUs } from '@sankyu/vue-circle-flags'
|
|
|
194
208
|
|
|
195
209
|
所有国旗组件均使用 TypeScript 完全类型化,开箱即用提供自动完成和类型安全。
|
|
196
210
|
|
|
211
|
+
> [!TIP]
|
|
212
|
+
> 欲了解更多信息,请参阅 [TypeScript 指南](https://react-circle-flags.js.org/docs/guides/getting-started/typescript/)。
|
|
213
|
+
|
|
197
214
|
```typescript
|
|
198
215
|
import type { FlagComponentProps, FlagCode } from '@sankyu/vue-circle-flags'
|
|
199
216
|
|
|
@@ -208,6 +225,9 @@ const invalid: FlagCode = 'xyz' // ✗ 类型错误
|
|
|
208
225
|
|
|
209
226
|
导入单个国旗可确保只有使用到的国旗被包含在您的打包文件中。
|
|
210
227
|
|
|
228
|
+
> [!TIP]
|
|
229
|
+
> 欲了解更多信息,请参阅 [打包大小与 Tree-shaking 优化指南](https://react-circle-flags.js.org/docs/guides/getting-started/bundle-size/)。
|
|
230
|
+
|
|
211
231
|
```vue
|
|
212
232
|
<script setup lang="ts">
|
|
213
233
|
// ✓ 推荐 - 仅打包 FlagUs 和 FlagCn
|