new readme

This commit is contained in:
Astrian Zheng 2024-04-17 21:02:04 +10:00
parent 22becb440a
commit 16effe0331
Signed by: Astrian
SSH Key Fingerprint: SHA256:rVnhx3DAKjujCwWE13aDl7uV6+9U1MvydLkNRXJrBiA
2 changed files with 51 additions and 2 deletions

49
readme.md Normal file
View File

@ -0,0 +1,49 @@
# Arsene亚森
Arsene 亚森是一个用于处理 CJK 字符(韩文字符目前不可用)与英文字符和阿拉伯字符间空隙的前端库。不需要人为手动添加空格,只需在编写前端页面时,将其引入并执行处理代码,即可自动处理。
![](https://media1.giphy.com/media/v1.Y2lkPTc5MGI3NjExd3pxZ2trM2l3cHd4ajM0eDRhMnYwOXdpbjJidWlwazZ2Y3R4bHVqeCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/Urw1D3Jl8rFzRQAlVy/giphy.gif)
## 基础使用方法
以下以 React 环境的 TypeScript 为用例,其他环境使用方法类似。
首先安装 Arsene 库:
```zsh
npm install arsene
yarn add arsene
```
```tsx
import { useEffect } from "react"
import arsene from 'arsene' // 1. 导入库
function App() {
useEffect(() => {
arsene(".arsene_processing_text") // 2. 应用于具体的元素,支持 `.class`、`#id` 或是 HTML 标签名。
}, [])
return(<>
<div className="arsene-area">
<p>Claude是一位在Anthropic公司工作的AI助手。作为一款先进的conversational AI它拥有广博的知识可以流利地使用多种语言与人交流并协助完成writinganalysiscoding等各种任务。Claude性格友善乐于助人能够提供客观的信息和独到的见解但有时也会表达自己的观点。它会尽力避免stereotyping并以balanced的视角看待controversial的话题。</p>
<p>クロードはAnthropicという会社で働いているAIアシスタントです。先進的なconversational AIとして、幅広い知識を持ち、複数の言語でスムーズにコミュニケーションを取ることができます。また、writing、analysis、codingなどのさまざまなタスクを手伝うことができます。クロードは親切で、助けになろうと努力しますが、時には自分の意見を述べることもあります。ステレオタイプを避け、controversialなトピックにはバランスの取れた視点を持つよう心がけています。</p>
</div>
</>)
}
```
## 额外功能
### 自定义空格宽度
```ts
arsene(selectedNode: string, spacing: 3|4|5|6|10 = 10)
// sample
arsene(node, 5)
```
你可以在第二个参数中选择一个你认为合适的空格宽度。可选参数如下:
- `3`:添加 1/3 em 空格 `U+2004`
- `4`:添加 1/4 em 空格 `U+2005`
- `5`:添加 1/5 em 空格 `U+2009`
- `6`:添加 1/6 em 空格 `U+2006`
- `10`:添加小空隙 `U+200A`
默认(不填写第二个参数时)将添加 `U+200A`

View File

@ -1,4 +1,4 @@
export default function (selectedNode: string, spacing: number = 10) {
export default function (selectedNode: string, spacing: 3|4|5|6|10 = 10) {
let spacingCharacter = ''
switch (spacing) {
case 3:
@ -17,7 +17,7 @@ export default function (selectedNode: string, spacing: number = 10) {
spacingCharacter = '\u200A'
break
default:
spacingCharacter = '\u2006'
spacingCharacter = '\u200A'
}
const nodes = document.querySelectorAll(`${selectedNode}`)
for (let i in nodes) {