Default props with class component
Using static defaultProps is correct. You should also be using interfaces, not classes, for the props and state.
Update 2018/12/1: TypeScript has improved the type-checking related to defaultProps over time. Read on for latest and greatest usage down to older usages and issues.
For TypeScript 3.0 and up
TypeScript specifically added support for defaultProps to make type-checking work how you'd expect. Example:
interface PageProps {
foo: string;
bar: string;
}
export class PageComponent extends React.Component<PageProps, {}> {
public static defaultProps = {
foo: "default"
};
public render(): JSX.Element {
return (
<span>Hello, { this.props.foo.toUpperCase() }</span>
);
}
}
Which can be rendered and compile without passing a foo attribute:
<PageComponent bar={ "hello" } />
Note that:
foois not marked optional (iefoo?: string) even though it's not required as a JSX attribute. Marking as optional would mean that it could beundefined, but in fact it never will beundefinedbecausedefaultPropsprovides a default value. Think of it similar to how you can mark a function parameter optional, or with a default value, but not both, yet both mean the call doesn't need to specify a value. TypeScript 3.0+ treatsdefaultPropsin a similar way, which is really cool for React users!- The
defaultPropshas no explicit type annotation. Its type is inferred and used by the compiler to determine which JSX attributes are required. You could usedefaultProps: Pick<PageProps, "foo">to ensuredefaultPropsmatches a sub-set ofPageProps. More on this caveat is explained here. - This requires
@types/reactversion16.4.11to work properly.
For TypeScript 2.1 until 3.0
Before TypeScript 3.0 implemented compiler support for defaultProps you could still make use of it, and it worked 100% with React at runtime, but since TypeScript only considered props when checking for JSX attributes you'd have to mark props that have defaults as optional with ?. Example:
interface PageProps {
foo?: string;
bar: number;
}
export class PageComponent extends React.Component<PageProps, {}> {
public static defaultProps: Partial<PageProps> = {
foo: "default"
};
public render(): JSX.Element {
return (
<span>Hello, world</span>
);
}
}
Note that:
- It's a good idea to annotate
defaultPropswithPartial<>so that it type-checks against your props, but you don't have to supply every required property with a default value, which makes no sense since required properties should never need a default. - When using
strictNullChecksthe value ofthis.props.foowill bepossibly undefinedand require a non-null assertion (iethis.props.foo!) or type-guard (ieif (this.props.foo) ...) to removeundefined. This is annoying since the default prop value means it actually will never be undefined, but TS didn't understand this flow. That's one of the main reasons TS 3.0 added explicit support fordefaultProps.
Before TypeScript 2.1
This works the same but you don't have Partial types, so just omit Partial<> and either supply default values for all required props (even though those defaults will never be used) or omit the explicit type annotation completely.
Default props with Functional Components
You can use defaultProps on function components as well, but you have to type your function to the FunctionComponent (StatelessComponent in @types/react before version 16.7.2) interface so that TypeScript knows about defaultProps on the function:
interface PageProps {
foo?: string;
bar: number;
}
const PageComponent: FunctionComponent<PageProps> = (props) => {
return (
<span>Hello, {props.foo}, {props.bar}</span>
);
};
PageComponent.defaultProps = {
foo: "default"
};
Note that you don't have to use Partial<PageProps> anywhere because FunctionComponent.defaultProps is already specified as a partial in TS 2.1+.
Another nice alternative (this is what I use) is to destructure your props parameters and assign default values directly:
const PageComponent: FunctionComponent<PageProps> = ({foo = "default", bar}) => {
return (
<span>Hello, {foo}, {bar}</span>
);
};
Then you don't need the defaultProps at all! Be aware that if you do provide defaultProps on a function component it will take precedence over default parameter values, because React will always explicitly pass the defaultProps values (so the parameters are never undefined, thus the default parameter is never used.) So you'd use one or the other, not both.
Default props with class component
Using static defaultProps is correct. You should also be using interfaces, not classes, for the props and state.
Update 2018/12/1: TypeScript has improved the type-checking related to defaultProps over time. Read on for latest and greatest usage down to older usages and issues.
For TypeScript 3.0 and up
TypeScript specifically added support for defaultProps to make type-checking work how you'd expect. Example:
interface PageProps {
foo: string;
bar: string;
}
export class PageComponent extends React.Component<PageProps, {}> {
public static defaultProps = {
foo: "default"
};
public render(): JSX.Element {
return (
<span>Hello, { this.props.foo.toUpperCase() }</span>
);
}
}
Which can be rendered and compile without passing a foo attribute:
<PageComponent bar={ "hello" } />
Note that:
foois not marked optional (iefoo?: string) even though it's not required as a JSX attribute. Marking as optional would mean that it could beundefined, but in fact it never will beundefinedbecausedefaultPropsprovides a default value. Think of it similar to how you can mark a function parameter optional, or with a default value, but not both, yet both mean the call doesn't need to specify a value. TypeScript 3.0+ treatsdefaultPropsin a similar way, which is really cool for React users!- The
defaultPropshas no explicit type annotation. Its type is inferred and used by the compiler to determine which JSX attributes are required. You could usedefaultProps: Pick<PageProps, "foo">to ensuredefaultPropsmatches a sub-set ofPageProps. More on this caveat is explained here. - This requires
@types/reactversion16.4.11to work properly.
For TypeScript 2.1 until 3.0
Before TypeScript 3.0 implemented compiler support for defaultProps you could still make use of it, and it worked 100% with React at runtime, but since TypeScript only considered props when checking for JSX attributes you'd have to mark props that have defaults as optional with ?. Example:
interface PageProps {
foo?: string;
bar: number;
}
export class PageComponent extends React.Component<PageProps, {}> {
public static defaultProps: Partial<PageProps> = {
foo: "default"
};
public render(): JSX.Element {
return (
<span>Hello, world</span>
);
}
}
Note that:
- It's a good idea to annotate
defaultPropswithPartial<>so that it type-checks against your props, but you don't have to supply every required property with a default value, which makes no sense since required properties should never need a default. - When using
strictNullChecksthe value ofthis.props.foowill bepossibly undefinedand require a non-null assertion (iethis.props.foo!) or type-guard (ieif (this.props.foo) ...) to removeundefined. This is annoying since the default prop value means it actually will never be undefined, but TS didn't understand this flow. That's one of the main reasons TS 3.0 added explicit support fordefaultProps.
Before TypeScript 2.1
This works the same but you don't have Partial types, so just omit Partial<> and either supply default values for all required props (even though those defaults will never be used) or omit the explicit type annotation completely.
Default props with Functional Components
You can use defaultProps on function components as well, but you have to type your function to the FunctionComponent (StatelessComponent in @types/react before version 16.7.2) interface so that TypeScript knows about defaultProps on the function:
interface PageProps {
foo?: string;
bar: number;
}
const PageComponent: FunctionComponent<PageProps> = (props) => {
return (
<span>Hello, {props.foo}, {props.bar}</span>
);
};
PageComponent.defaultProps = {
foo: "default"
};
Note that you don't have to use Partial<PageProps> anywhere because FunctionComponent.defaultProps is already specified as a partial in TS 2.1+.
Another nice alternative (this is what I use) is to destructure your props parameters and assign default values directly:
const PageComponent: FunctionComponent<PageProps> = ({foo = "default", bar}) => {
return (
<span>Hello, {foo}, {bar}</span>
);
};
Then you don't need the defaultProps at all! Be aware that if you do provide defaultProps on a function component it will take precedence over default parameter values, because React will always explicitly pass the defaultProps values (so the parameters are never undefined, thus the default parameter is never used.) So you'd use one or the other, not both.
With Typescript 2.1+, use Partial < T > instead of making your interface properties optional.
export interface Props {
obj: Model,
a: boolean
b: boolean
}
public static defaultProps: Partial<Props> = {
a: true
};
Typescript interface default values - Stack Overflow
Defaulting Unspecified Interface Properties to Null in TypeScript - Ask a Question - TestMu AI Community
Default value for interface property?
If you have Object.assign, or a polyfill for it, or something similar like $.extend in jQuery, then you can do:
const settings = Object.assign({}, defaults, options);
The es6.d.ts declaration looks like this:
assign<T, U>(target: T, source: U): T & U; assign<T, U, V>(target: T, source1: U, source2: V): T & U & V; assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W; assign(target: any, ...sources: any[]): any;
i.e. strongly-typed overloads up to 4 arguments. So you should get back an object whose type is the intersection of the arguments you passed in.
In short, this will perform defaulting for multiple properties in one go.
More on reddit.comWhy are props not marked as readonly by default in TypeScript?
Can I tell the interface to default the properties I don't supply to null? What would let me do this
No. You cannot provide default values for interfaces or type aliases as they are compile time only and default values need runtime support
Alternative
But values that are not specified default to undefined in JavaScript runtimes. So you can mark them as optional:
interface IX {
a: string,
b?: any,
c?: AnotherType
}
And now when you create it you only need to provide a:
let x: IX = {
a: 'abc'
};
You can provide the values as needed:
x.a = 'xyz'
x.b = 123
x.c = new AnotherType()
You can't set default values in an interface, but you can accomplish what you want to do by using optional properties:
Simply change the interface to:
interface IX {
a: string,
b?: any,
c?: AnotherType
}
You can then do:
let x: IX = {
a: 'abc'
}
And use your init function to assign default values to x.b and x.c if those properies are not set.
So, I'm playing around with React+TS.
Some Components takes optional style property, and assigns few properties by itself.
Atm I'm using this:
const style = typeof this.props.style === 'object' ? this.props.style : {}; // Default value for styleI'm sure there's simplier way todo that without checking if optional parameter was given.
Thanks in advance!