React Sublime Snippets

Feeling bored with typing or even copying React codes to write React components and test cases? If you use Sublime, hope these code snippets can help you enjoy writing your React components.

The snippets follow JavaScript ES6 syntax, we don't use the old React.createClass({...}) anymore, we write class component and functional component. Also we provide snippets to quickly write React Lifecycle functions (e.g. componentDidMount).

Examples

ES6 Class Component

Functional Component

Test Case (with chai assert and enzyme)

Snippets

ES6 Class Component rcc + <TAB>

import React, { Component, PropTypes } from 'react';

class ${1:Component} extends Component {
    static propTypes = {
        className: PropTypes.string,
    };

    constructor(props) {
        super(props);
    }

    render() {
        return (
            ${0}
        );
    }
}

export default ${1:Component};

ES6 Class Component with injectIntl rcci + <TAB>

import React, { Component, PropTypes } from 'react';
import { injectIntl, intlShape } from 'react-intl';

class ${1:Component} extends Component {
    static propTypes = {
        intl: intlShape.isRequired,
    };

    constructor(props) {
        super(props);
    }

    render() {
        const { formatMessage } = this.props.intl;

        return (
            ${0}
        );
    }
}

export default injectIntl(${1:Component});

Functional Component rfc + <TAB>

import React, { PropTypes } from 'react';

const ${1:Component} = ({
    className = '',
}) => {
    return (
        <div>
            ${0}
        </div>
    );
};

${1:Component}.displayName = '${1:Component}';

${1:Component}.propTypes = {
    className: PropTypes.string,
};

export default ${1:Component};

Functional Component with injectIntl rfci + <TAB>

import React, { PropTypes } from 'react';
import { injectIntl, intlShape } from 'react-intl';

const ${1:Component} = ({
    intl,
}) => {
    const { formatMessage } = intl;

    return (
        ${0}
    );
};

${1:Component}.displayName = '${1:Component}';

${1:Component}.propTypes = {
    intl: intlShape.isRequired,
};

export { ${1:Component} };

export default injectIntl(${1:Component});

static propTypes rspt + <TAB>

static propTypes = {
    ${1:prop}: PropTypes.${2:string},
};

static defaultProps rdp + <TAB>

static defaultProps = {
    ${1:prop}: ${2:value},
};

Define Formatted Messages rdm + <TAB>

const messages = defineMessages({
    ${1:message}: {
        defaultMessage: '${2:default message}',
        description: '${3:description}',
        id: '${4:id}',
    },
});

Define New Formatted Message rnm + <TAB>

${1:message}: {
    defaultMessage: '${2:default message}',
    description: '${3:description}',
    id: '${4:id}',
},

componentDidMount() rcdm + <TAB>

componentDidMount() {
    ${1}
}

componentDidUpdate(prevProps, prevState) rdu + <TAB>

componentDidUpdate(prevProps, prevState) {
    ${1}
}

componentWillMount rwm + <TAB>

componentWillMount() {
    ${1}
}

componentWillReceiveProps(nextProps) rcwrp + <TAB>

componentWillReceiveProps(nextProps) {
    ${1}
}

componentWillUnmount() rcwum + <TAB>

componentWillUnmount() {
    ${1}
}

componentWillUpdate(nextProps, nextState) rcwu + <TAB>

componentWillUpdate(nextProps, nextState) {
    ${1}
}

shouldComponentUpdate(nextProps, nextState) rscu + <TAB>

shouldComponentUpdate(nextProps, nextState) {
    return ${1};
}

React Test Case (chai assert and enzyme) rt + <TAB>

import React from 'react';
import { assert } from 'chai';
import { shallow } from 'enzyme';
import ${1:Component} from '${2:../component}';

const sandbox = sinon.sandbox.create();

describe('${1:Component}', () => {
    afterEach(() => {
        sandbox.verifyAndRestore();
    });

    beforeEach(() => {
        ${3}
    });

    it('should render ${1:Component} correctly', () => {
        const component = shallow(
            <${1:Component} />
        );
        ${4}
    });
});

React Test Describe rtd + <TAB>

describe('${1:...}', () => {
    afterEach(() => {
        ${2}
    });

    beforeEach(() => {
        ${3}
    });

    it('should ${4:...}', () => {
        ${0}
    });
});

React Test it() rti + <TAB>

it('should ${1:...}', () => {
    ${0}
});

import rim + <TAB>

import ${1:Package} from '${2:path}';

Installation

Without Package Control

At the time of writing, this package is not in wbond's Package Control repository yet, so you have to navigate to your Sublime Text packages folder and git clone our project.

Mac OS

"~/Library/Application Support/Sublime Text 3/Packages"

Windows 7

"C:\Users\YOUR_USERNAME\AppData\Roaming\Sublime Text 3\Packages"

git clone https://github.com/jeantimex/react-sublime-snippet.git "React-Sublime-Snippets"

Authors

• Yong Su - Box Inc. - jeantimex

License

This project is licensed under the MIT License.