Kindle-UI

English Version | 简体中文

一个用于在浏览器中构建 Kindle 界面的 React 组件库。

本项目是我高考前最后一个坑啦，欢迎 PR！

Amazon 官方已于今年八月陆续推送新版本的 UI。

🍊 特性

• 11 个交互式 Kindle 组件（对话框、按钮、列表、文本框、导航栏...）
• 夜间模式
• 原汁原味 Kindle OS 字体（可选）
• Kindle 经典外观复刻（Kindle Oasis, Kindle Paperwhite, Kindle Voyage）
• 100% TypeScript
• 多样式对话框
• Expermintal Browser App
• Font Setting App

npm i kindle-ui

App

App 是 kindle 中高度集成的应用程序，大多数情况下你无法对其进行编辑。 如果你在你的项目中使用它们，你可能还需要自己添加一个路由器。

实验性浏览器

🪟 组件

Navbar

Navbar 是一个集成的 Kindle 原生组件。 所有图标都是不可编辑的，但你仍然可以更改一些状态和回调函数，例如电池、设备名称等。

Example:

<Navbar>
	<StatuBar
		airplane
		celluar={{
			on: true,
			label: "LTE",
			siginal: 3,
		}}
		battery={86}
		deviceName="My Kindle"
	/>
	<ActionBar>
		<ActionGroup>
			<ActionItem
				onClick={() => {
					history.push("/");
				}}
			>
				<HomeOutlineIcon />
				home
			</ActionItem>
			<ActionItem
				onClick={() => {
					history.goBack();
				}}
			>
				<ArrowBackSharpIcon />
				BACK
			</ActionItem>
			<ActionItem>
				<CogSharpIcon />
				settings
			</ActionItem>
		</ActionGroup>
		<ActionBarSpace />
		<ActionGroup>
			<SearchBar />
			<ActionBarMenu
				items={[
					{
						textPrimary: "Github",
						component: "a",
						href: "https://github.com/rivertwilight",
					},
				]}
			/>
		</ActionGroup>
	</ActionBar>
</Navbar>

Container

使用 Container 容器可以赋予颜色模式切换的能力，并且可以添加设备外观。

import { Container, KindleOasis } from "@kindle-ui/core";

function App() {
	return (
		<Container dark deviceFrame={KindleOasis}>
            {/* ... */}
		</Container>
	);
}

Typography

使用Typography来呈现文章或其他富文本内容。

name	optional	default	description
greyImage	false	true	图片显示为黑白

Button

name	optional	default	description
href	true	--	--

List

Example:

	<List>
		<ListItem component={Link} to="/reader">
			<ListItemText primary="尘埃落定" second="阿来著" />
		</ListItem>
		<ListItem component="a" href="https://github.com">
			<ListItemText
				primary="The Adventure of Sherlok Holmoes (福尔摩斯探案集）"
				second="Arthur Conan Doyle"
			/>
			<ListItemIcon
				onClick={() => {
					alert("Hello");
				}}
			>
				<EllipsisVerticalIcon />
			</ListItemIcon>
		</ListItem>
	</List>

name	optional	default	description
href	true	--	--

Grid

该组件模仿 Kindle 的书架布局。

字体

如果要使用 Kindle 原生字体，需要先安装kindle-fonts.

npm i kindle-fonts
# or
yarn add kindle-fonts

Then import it in your project:

import "kindle-fonts/bookerly.css";
import "kindle-fonts/amazon-ember.css";

贡献

我们十分欢迎你参与建设。请参见 CONTRIBUTING.md。

License

MIT

灵感来源于 这个博客