将样式组件与 props 和 TypeScript 一起使用
Using styled-components with props and TypeScript
我正在尝试将 TypeScript 集成到我们的项目中,到目前为止我偶然发现了 styled-components 库的一个问题。
考虑这个组件
import * as React from "react";
import styled from "styled-components/native";
import { TouchableOpacity } from "react-native";
// -- types ----------------------------------------------------------------- //
export interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
// -- styling --------------------------------------------------------------- //
const Icon = styled.Image`
width: ${(p: Props) => p.width};
height: ${(p: Props) => p.height};
`;
class TouchableIcon extends React.Component<Props> {
// -- default props ------------------------------------------------------- //
static defaultProps: Partial<Props> = {
src: null,
width: "20px",
height: "20px"
};
// -- render -------------------------------------------------------------- //
render() {
const { onPress, src, width, height } = this.props;
return (
<TouchableOpacity onPress={onPress}>
<Icon source={src} width={width} height={height} />
</TouchableOpacity>
);
}
}
export default TouchableIcon;
下一行抛出 3 个错误,本质上是相同的 <Icon source={src} width={width} height={height} />
Type {source: any; width: string; height: string;} is not assignable
to type IntrinsicAttributes ... Property 'onPress' is missing in type
{source: any; width: string; height: string;}
不完全确定这是什么以及如何修复它,我是否需要以某种方式在 Icon
或类似的东西上声明这些?
编辑: 打字稿 v2.6.1
,样式组件 v2.2.3
我自己也在努力解决这个问题,但我认为问题在于您在样式化组件中使用了 Props 接口。尝试仅使用图像道具创建另一个界面并在您的样式组件中使用它:
import * as React from "react";
import styled from "styled-components/native";
import { TouchableOpacity } from "react-native";
// -- types ----------------------------------------------------------------- //
export interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
export interface ImageProps {
src: string;
width: string;
height: string;
}
// -- styling --------------------------------------------------------------- //
const Icon = styled.Image`
width: ${(p: ImageProps ) => p.width};
height: ${(p: ImageProps ) => p.height};
`;
class TouchableIcon extends React.Component<Props> {
// -- default props ------------------------------------------------------- //
static defaultProps: Partial<Props> = {
src: null,
width: "20px",
height: "20px"
};
// -- render -------------------------------------------------------------- //
render() {
const { onPress, src, width, height } = this.props;
return (
<TouchableOpacity onPress={onPress}>
<Icon source={src} width={width} height={height} />
</TouchableOpacity>
);
}
}
export default TouchableIcon;
似乎可行,但我讨厌必须复制这些界面。希望其他人可以展示正确的方法或者将 ImageProps 嵌入到 Props 中?
这个答案已经过时了,最新的答案在这里:
据我所知,目前还没有正式的方法(还?)来执行此操作,但您可以通过一些技巧来解决它。首先,创建一个包含以下内容的 withProps.ts
文件:
import * as React from 'react'
import { ThemedStyledFunction } from 'styled-components'
const withProps = <U>() => <P, T, O>(fn: ThemedStyledFunction<P, T, O>) =>
fn as ThemedStyledFunction<P & U, T, O & U>
export { withProps }
现在,在您的 .tsx
文件中,像这样使用它:
// ... your other imports
import { withProps } from './withProps'
export interface IconProps {
onPress: any;
src: any;
width: string;
height: string;
}
const Icon = withProps<IconProps>()(styled.Image)`
width: ${(p: IconProps) => p.width};
height: ${(p: IconProps) => p.height};
`;
你应该可以开始了。这绝对 不 理想,希望很快就会有一种方法在 TS 中为模板文字提供泛型,但我想现在这是你最好的选择。
信用是在信用到期的地方给出的:我从here
复制粘贴了这个
最近有了一些发展,有了新版本的 Typescript(例如 3.0.1)和样式组件(例如 3.4.5),就不需要单独的助手了。您可以直接将道具的 interface/type 指定给 styled-components。
interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
const Icon = styled.Image<Props>`
width: ${p => p.width};
height: ${p => p.height};
`;
如果您想更精确地忽略 onPress
const Icon = styled.Image<Pick<Props, 'src' | 'width' | 'height'>>`
width: ${p => p.width};
height: ${p => p.height};
`;
您只需指定一个 interface
:
import { createGlobalStyle } from 'styled-components';
interface PropsGlobalStyle {
dark: boolean
}
export default createGlobalStyle`
body {
box-sizing: border-box;
margin: 0;
font-family: Arial, Helvetica, sans-serif;
color: ${(props:PropsGlobalStyled) => (props.dark ? '#FFF' : '#000')};
background-color: ${(props:PropsGlobalStyled) => (props.dark ? '#000' : '#FFF')};
}
`;
样式组件
import styled from 'styled-components';
interface Props {
height: number;
}
export const Wrapper = styled.div<Props>`
padding: 5%;
height: ${(props) => props.height}%;
`;
指数
import React, { FunctionComponent } from 'react';
import { Wrapper } from './Wrapper';
interface Props {
className?: string;
title: string;
height: number;
}
export const MainBoardList: FunctionComponent<Props> = ({ className, title, height }) => (
<Wrapper height={height} className={className}>
{title}
</Wrapper>
);
应该可以
使用 ColorCard
和颜色属性
的示例
import styled from 'styled-components';
export const ColorCard = styled.div<{ color: string }>`
background-color: ${({ color }) => color};
`;
@elnygren 的回答对我有用。我只有一个问题。如何为以下代码分配默认值(从@elnygren 的回答中复制)。例如如果我不想将任何值传递给 'width' 和 'height',将使用默认值。
const Icon = styled.Image<Pick<Props, 'src' | 'width' | 'height'>>`
width: ${p => p.width};
height: ${p => p.height};
`;
最简单的方法如styled-components docs所说:
import styled from 'styled-components';
import Header from './Header';
const NewHeader = styled(Header)<{ customColor: string }>`
color: ${(props) => props.customColor};
`;
// Header will also receive props.customColor
我正在尝试将 TypeScript 集成到我们的项目中,到目前为止我偶然发现了 styled-components 库的一个问题。
考虑这个组件
import * as React from "react";
import styled from "styled-components/native";
import { TouchableOpacity } from "react-native";
// -- types ----------------------------------------------------------------- //
export interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
// -- styling --------------------------------------------------------------- //
const Icon = styled.Image`
width: ${(p: Props) => p.width};
height: ${(p: Props) => p.height};
`;
class TouchableIcon extends React.Component<Props> {
// -- default props ------------------------------------------------------- //
static defaultProps: Partial<Props> = {
src: null,
width: "20px",
height: "20px"
};
// -- render -------------------------------------------------------------- //
render() {
const { onPress, src, width, height } = this.props;
return (
<TouchableOpacity onPress={onPress}>
<Icon source={src} width={width} height={height} />
</TouchableOpacity>
);
}
}
export default TouchableIcon;
下一行抛出 3 个错误,本质上是相同的 <Icon source={src} width={width} height={height} />
Type {source: any; width: string; height: string;} is not assignable to type IntrinsicAttributes ... Property 'onPress' is missing in type {source: any; width: string; height: string;}
不完全确定这是什么以及如何修复它,我是否需要以某种方式在 Icon
或类似的东西上声明这些?
编辑: 打字稿 v2.6.1
,样式组件 v2.2.3
我自己也在努力解决这个问题,但我认为问题在于您在样式化组件中使用了 Props 接口。尝试仅使用图像道具创建另一个界面并在您的样式组件中使用它:
import * as React from "react";
import styled from "styled-components/native";
import { TouchableOpacity } from "react-native";
// -- types ----------------------------------------------------------------- //
export interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
export interface ImageProps {
src: string;
width: string;
height: string;
}
// -- styling --------------------------------------------------------------- //
const Icon = styled.Image`
width: ${(p: ImageProps ) => p.width};
height: ${(p: ImageProps ) => p.height};
`;
class TouchableIcon extends React.Component<Props> {
// -- default props ------------------------------------------------------- //
static defaultProps: Partial<Props> = {
src: null,
width: "20px",
height: "20px"
};
// -- render -------------------------------------------------------------- //
render() {
const { onPress, src, width, height } = this.props;
return (
<TouchableOpacity onPress={onPress}>
<Icon source={src} width={width} height={height} />
</TouchableOpacity>
);
}
}
export default TouchableIcon;
似乎可行,但我讨厌必须复制这些界面。希望其他人可以展示正确的方法或者将 ImageProps 嵌入到 Props 中?
这个答案已经过时了,最新的答案在这里:
据我所知,目前还没有正式的方法(还?)来执行此操作,但您可以通过一些技巧来解决它。首先,创建一个包含以下内容的 withProps.ts
文件:
import * as React from 'react'
import { ThemedStyledFunction } from 'styled-components'
const withProps = <U>() => <P, T, O>(fn: ThemedStyledFunction<P, T, O>) =>
fn as ThemedStyledFunction<P & U, T, O & U>
export { withProps }
现在,在您的 .tsx
文件中,像这样使用它:
// ... your other imports
import { withProps } from './withProps'
export interface IconProps {
onPress: any;
src: any;
width: string;
height: string;
}
const Icon = withProps<IconProps>()(styled.Image)`
width: ${(p: IconProps) => p.width};
height: ${(p: IconProps) => p.height};
`;
你应该可以开始了。这绝对 不 理想,希望很快就会有一种方法在 TS 中为模板文字提供泛型,但我想现在这是你最好的选择。
信用是在信用到期的地方给出的:我从here
复制粘贴了这个最近有了一些发展,有了新版本的 Typescript(例如 3.0.1)和样式组件(例如 3.4.5),就不需要单独的助手了。您可以直接将道具的 interface/type 指定给 styled-components。
interface Props {
onPress: any;
src: any;
width: string;
height: string;
}
const Icon = styled.Image<Props>`
width: ${p => p.width};
height: ${p => p.height};
`;
如果您想更精确地忽略 onPress
const Icon = styled.Image<Pick<Props, 'src' | 'width' | 'height'>>`
width: ${p => p.width};
height: ${p => p.height};
`;
您只需指定一个 interface
:
import { createGlobalStyle } from 'styled-components';
interface PropsGlobalStyle {
dark: boolean
}
export default createGlobalStyle`
body {
box-sizing: border-box;
margin: 0;
font-family: Arial, Helvetica, sans-serif;
color: ${(props:PropsGlobalStyled) => (props.dark ? '#FFF' : '#000')};
background-color: ${(props:PropsGlobalStyled) => (props.dark ? '#000' : '#FFF')};
}
`;
样式组件
import styled from 'styled-components';
interface Props {
height: number;
}
export const Wrapper = styled.div<Props>`
padding: 5%;
height: ${(props) => props.height}%;
`;
指数
import React, { FunctionComponent } from 'react';
import { Wrapper } from './Wrapper';
interface Props {
className?: string;
title: string;
height: number;
}
export const MainBoardList: FunctionComponent<Props> = ({ className, title, height }) => (
<Wrapper height={height} className={className}>
{title}
</Wrapper>
);
应该可以
使用 ColorCard
和颜色属性
import styled from 'styled-components';
export const ColorCard = styled.div<{ color: string }>`
background-color: ${({ color }) => color};
`;
@elnygren 的回答对我有用。我只有一个问题。如何为以下代码分配默认值(从@elnygren 的回答中复制)。例如如果我不想将任何值传递给 'width' 和 'height',将使用默认值。
const Icon = styled.Image<Pick<Props, 'src' | 'width' | 'height'>>`
width: ${p => p.width};
height: ${p => p.height};
`;
最简单的方法如styled-components docs所说:
import styled from 'styled-components';
import Header from './Header';
const NewHeader = styled(Header)<{ customColor: string }>`
color: ${(props) => props.customColor};
`;
// Header will also receive props.customColor