API 的设计方法
我们在如何使用 Material-UI 方面学到了很多相关的只是,而通过 v1 版本的重写,我们能够彻底重新考虑组件的 API。
API 设计的难点在于你可以让一些复杂的东西看起来简单,也可能把简单的东西搞得复杂。
正如Sebastian Markbage 指出,没有抽象也优于错误的抽象。 我们提供低级的组件以最大化使用封装功能。
封装
您可能已经注意到 API 中有关封装组件的一些不一致。 为了给予一些透明度,我们在设计 API 时一直使用以下的规则:
- 用 React 进行封装的惯用方法是使用
children
属性。 - 有时我们只需要有限的子组件封装,例如,当我们不需要允许子组件的顺序排列的时候。 在这种情况下,提供显式属性可以使实现更简单,更高效;例如,
Tab
接受了一个icon
和一个label
属性。 - API 的一致性至关重要。
规则
除了上述封装规则的取舍之外,我们还执行以下这些:
扩展
如果您提供组件的属性如果没有明确说明,那么它将会被扩展到根元素;例如,className
属性会被应用于根元素。
现在,假设您要禁用 MenuItem
上的涟漪效果。 您可以使用扩展的行为:
<MenuItem disableRipple />
disableRipple
属性这样传播开来:MenuItem
> ListItem
> ButtonBase
。
原生属性
我们避免记录 DOM 支持的那些原生属性,如className
。
CSS classes
为了自定义样式,所有组件都接受 classes
属性。 类的设计解决了两个约束:使类的结构尽可能简单,同时足以实现 Material Design 的规范。
- 应用于根元素的类始终称为
root
。 - 所有默认样式都分组在单个类中。
- 应用于非根元素的类则以元素的名称为前缀,例如, Dialog 组件中的
paperWidthXs
。 - 由一个布尔(boolean)属性应用的变体并没有前缀,如
rounded
属性应用于rounded
类。 - 由 enum 属性应用的变体是有前缀的,例如
color = "primary"
属性应用于colorPrimary
类。 - 一个变体(variant)具有** 一个级别的特异性**。
color
和variant
属性被视为一个变体。 样式特异性越低,它就越容易被覆盖。 - 我们增加了变体修饰符(variant modifier)的特异性。 对于伪类(pseudo-classes)(
:hover
,:focus
等),我们必须这样做。 以更多模板为代价,它才会开放更多的控制权。 我们也希望,它也能更加直观。
const styles = {
root: {
color: green[600],
'&$checked': {
color: green[500],
},
},
checked: {},
};
嵌套的组件
一个组件内的嵌套组件具有:
- 它们自己的扁平化属性(当这些属性是顶层组件抽象的关键时),例如
Input
组件的id
属性。 - 当用户可能需要调整内部渲染方法的子组件时,会有它们自己的
xxxProps
属性,例如,在内部使用input
的组件时,公开inputProps
和InputProps
属性。 - 它们有自己的
xxxComponent
属性,用于执行组件的注入。 - 当您可能需要执行命令性操作时,例如,公开
inputRef
属性以访问input
组件上的原生input
,您就可以使用它们自己的xxxRef
属性。 这个方法有助于解答 “我应该怎么访问 DOM 元素?”。
属性名称
一个布尔属性的名称则应根据默认值来决定。 例如,若提供了一个输入框元素的 disabled
属性,则默认值为 true
。 此选项允许简写的表示:
-<Input enabled={false} />
+<Input disabled />
受控的组件
您能够通过 value
和 onChange
属性来控制大多数的受控组件,但是,open
/ onClose
/ onOpen
的组合用于显示相关的状态。
boolean vs enum
当设计组件的变体的 API 时,有两种选择:使用一个 boolean;或者使用一个enum。 比如说,我们选取了一个有着不同类型的按钮组件。 每个选项都有其优缺点:
选项 1 布尔值(boolean):
type Props = { contained: boolean; fab: boolean; };
该 API 启用了简写的表示法:
<Button>
,<Button contained />
,<Button fab />
。选项 2 枚举(enum):
type Props = { variant: 'text' | 'contained' | 'fab'; }
这个 API 会更加详细:
<Button>
,<Button variant="contained">
,<Button variant="fab">
。但是它可以阻止使用无效的组合,限制公开的属性数量,并且在将来可以轻松地支持新的值。
Material-UI 组件根据以下规则将两种方法结合使用:
- 当需要 2 个可能的值时,我们使用 boolean。
- 当需要 2 个或在将来可能需要其他更多的值时,那么就使用 enum。
若回到之前的按钮组件示例;因为它需要 3 个可能的值,所以我们使用了 enum。
Ref
ref
则会被传递到根元素中。 这意味着,在不通过 component
属性改变渲染的根元素的情况下,它将会被传递到组件渲染的最外层 DOM 元素中。 如果您通过 component
属性传递给不同的组件,那么 ref 将会被附加到该组件上。
术语表
- host component:
react-dom
的 DOM 节点类型,例如,一个“div”
。 另请参阅 React 实施说明。 - host element:
react-dom
中的一个 DOM 节点,例如window.HTMLDivElement
的实例。 - outermost:从上到下读取组件树时的第一个组件,例如,广度优先(breadth-first)搜索。
- root component:渲染一个宿主组件的最外层的那个组件。
- root element:渲染一个宿主组件的最外层的那个元素。