newspaperui 0.2.0 → 0.2.1
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 +51 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# NewspaperUI
|
|
2
|
+
|
|
3
|
+
Editorial React components for production newspaper layouts.
|
|
4
|
+
|
|
5
|
+
- [中文文档](https://joisun.github.io/newspaperui/)
|
|
6
|
+
- [English documentation](https://joisun.github.io/newspaperui/en/)
|
|
7
|
+
- [Browse blocks](https://joisun.github.io/newspaperui/blocks/)
|
|
8
|
+
- [Create a theme](https://joisun.github.io/newspaperui/create/)
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pnpm add newspaperui
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
NewspaperUI supports React 18 and later. React and React DOM are supplied by your application.
|
|
17
|
+
|
|
18
|
+
## Quick start
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import 'newspaperui/style.css';
|
|
22
|
+
import { Article, BodyText, Headline, Layout, Section } from 'newspaperui';
|
|
23
|
+
|
|
24
|
+
export function FrontPage() {
|
|
25
|
+
return (
|
|
26
|
+
<Layout columns={24}>
|
|
27
|
+
<Section columns={24}>
|
|
28
|
+
<Article span={16}>
|
|
29
|
+
<Headline as="h1" weight="High">
|
|
30
|
+
The morning edition
|
|
31
|
+
</Headline>
|
|
32
|
+
<BodyText columns={2} dropCap>
|
|
33
|
+
<p>Compose the story with a real editorial reading flow.</p>
|
|
34
|
+
</BodyText>
|
|
35
|
+
</Article>
|
|
36
|
+
</Section>
|
|
37
|
+
</Layout>
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Highlights
|
|
43
|
+
|
|
44
|
+
- Responsive composition on a 24-column editorial grid.
|
|
45
|
+
- Multi-column text, drop caps, rules, captions, quotes, and publication metadata.
|
|
46
|
+
- Typography presets for English, Chinese, Japanese, and German layouts.
|
|
47
|
+
- Light and dark themes, complete example editions, and a visual theme creator.
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "newspaperui",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Production-grade newspaper layout React components with built-in theme and utilities",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist"
|
|
19
19
|
],
|
|
20
20
|
"peerDependencies": {
|
|
21
|
-
"react": "
|
|
22
|
-
"react-dom": "
|
|
21
|
+
"react": ">=18.0.0",
|
|
22
|
+
"react-dom": ">=18.0.0"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@testing-library/react": "^16.1.0",
|