Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TASK: rewrite react-ui-components in TypeScript #2128

Merged
merged 19 commits into from
Sep 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ Resources/Public/Styles/**/*.map
Resources/Public/Styles/Font*
lerna-debug.log
npm-debug.log

#
# editors / IDEs
#
.vscode/
.idea/
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@
"ts-loader": "^3",
"tslib": "^1.9.3",
"tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0",
"tslint-immutable": "^4.7.0",
"tslint-react": "^3.6.0",
"typescript": "^3.0.1",
"watch": "^1.0.2",
"webpack": "^3.8.1",
Expand Down
13 changes: 12 additions & 1 deletion packages/react-ui-components/.storybook/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ module.exports = (storybookBaseConfig, configType) => {
//
module: {
rules: [
{
test: /\.tsx?$/,
exclude: /(node_modules)/,
use: [{
loader: 'ts-loader'
}]
},
{
test: /\.js$/,
exclude: /(node_modules)/,
Expand Down Expand Up @@ -58,6 +65,10 @@ module.exports = (storybookBaseConfig, configType) => {
}]
}
]
}
},

resolve: {
extensions: ['.ts', '.tsx', '.js']
},
});
};
2 changes: 1 addition & 1 deletion packages/react-ui-components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"babel": "babel ./src --out-dir ./lib",
"css": "cpx './src/**/*.css' ./lib && cpx './src/**/*.woff' ./lib && cpx './src/**/*.woff2' ./lib",
"clean": "rimraf ./lib ./dist",
"lint": "eslint src && stylelint 'src/**/*.css'",
"lint": "eslint src && stylelint 'src/**/*.css' && tslint -t codeFrame -p ../tsconfig.json -c ../../tslint.json",
JamesAlias marked this conversation as resolved.
Show resolved Hide resolved
"jest": "NODE_ENV=test jest",
"jest:updateSnapshots": "NODE_ENV=test jest -u",
"start": "cross-env STORY=true start-storybook -p 9001"
Expand Down
44 changes: 0 additions & 44 deletions packages/react-ui-components/src/Badge/badge.js

This file was deleted.

2 changes: 1 addition & 1 deletion packages/react-ui-components/src/Badge/badge.spec.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react';
import {shallow} from 'enzyme';
import toJson from 'enzyme-to-json';
import Badge from './badge.js';
import Badge from './badge';

describe('<Badge/>', () => {
let props;
Expand Down
41 changes: 41 additions & 0 deletions packages/react-ui-components/src/Badge/badge.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import mergeClassNames from 'classnames';
import React, {PureComponent} from 'react';

interface BadgeTheme {
readonly badge: string;
}

interface BadgeProps {
/**
* An optional `className` to attach to the wrapper.
*/
readonly className?: string;

/**
* Badge's label.
*/
readonly label: string;

/**
* An optional css theme to be injected.
*/
readonly theme?: BadgeTheme;
}

class Badge extends PureComponent<BadgeProps> {
public render(): JSX.Element {
const {
className,
theme,
label,
...rest
} = this.props;
const finalClassName = mergeClassNames(theme!.badge, className);

return (
<div {...rest} className={finalClassName}>{label}</div>
);
}
}

export default Badge;
4 changes: 2 additions & 2 deletions packages/react-ui-components/src/Badge/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {themr} from '@friendsofreactjs/react-css-themr';
import identifiers from './../identifiers';
import identifiers from '../identifiers';
import style from './style.css';
import Badge from './badge.js';
import Badge from './badge';

export default themr(identifiers.badge, style)(Badge);
2 changes: 1 addition & 1 deletion packages/react-ui-components/src/Badge/index.spec.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Badge from './index.js';
import Badge from '.';

describe('<Badge/> (entry point)', () => {
it('should export a Component.', () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/react-ui-components/src/Badge/index.story.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import React from 'react';
import {storiesOf} from '@storybook/react';
import {withKnobs, text} from '@storybook/addon-knobs';
import {StoryWrapper} from './../_lib/storyUtils.js';
import Badge from './index.js';
import {StoryWrapper} from './../_lib/storyUtils';
import Badge from '.';

storiesOf('Badge', module)
.addDecorator(withKnobs)
Expand Down
49 changes: 0 additions & 49 deletions packages/react-ui-components/src/Bar/bar.js

This file was deleted.

2 changes: 1 addition & 1 deletion packages/react-ui-components/src/Bar/bar.spec.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react';
import {shallow} from 'enzyme';
import toJson from 'enzyme-to-json';
import Bar from './bar.js';
import Bar from './bar';

describe('<Bar/>', () => {
let props;
Expand Down
59 changes: 59 additions & 0 deletions packages/react-ui-components/src/Bar/bar.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import mergeClassNames from 'classnames';
import React, {PureComponent} from 'react';

type BarPosition = 'top' | 'bottom';

interface BarTheme {
readonly 'bar': string;
readonly 'bar--top': string;
readonly 'bar--bottom': string;
}

interface BarProps {
/**
* This prop controls the vertical positioning of the Bar.
*/
readonly position: BarPosition;

/**
* An optional css theme to be injected.
*/
readonly theme?: BarTheme;

/**
* An optional `className` to attach to the wrapper.
*/
readonly className?: string;

/**
* The contents to be rendered within the `Bar`.
*/
readonly children: React.ReactNode;
}

class Bar extends PureComponent<BarProps> {
public render(): JSX.Element {
const {position, className, theme, children, ...rest} = this.props;
const finalClassName = mergeClassNames(
className,
theme!.bar,
{
[theme!['bar--top']]: position === 'top',
[theme!['bar--bottom']]: position === 'bottom'
}
);

// TODO:
// The prop 'rest' is empty here. I suppose it contains all the attributes that are not part of the Badge Api/Interface.
// Consider enxtending Bagde with React.HTMLAttributes<HTMLDivElement> like we did in the Button component.
// It also enables autocomplete for the whole div Api.
// Consider this for the other components.
return (
<div className={finalClassName} {...rest}>
JamesAlias marked this conversation as resolved.
Show resolved Hide resolved
{children}
</div>
);
}
}

export default Bar;
4 changes: 2 additions & 2 deletions packages/react-ui-components/src/Bar/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {themr} from '@friendsofreactjs/react-css-themr';
import identifiers from './../identifiers';
import identifiers from '../identifiers';
import style from './style.css';
import Bar from './bar.js';
import Bar from './bar';

export default themr(identifiers.bar, style)(Bar);
2 changes: 1 addition & 1 deletion packages/react-ui-components/src/Bar/index.spec.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Bar from './index.js';
import Bar from '.';

describe('<Bar/> (entry point)', () => {
it('should export a Component.', () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/react-ui-components/src/Bar/index.story.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import React from 'react';
import {storiesOf} from '@storybook/react';
import {withKnobs, select} from '@storybook/addon-knobs';
import {StoryWrapper} from './../_lib/storyUtils.js';
import Bar from './index.js';
import {StoryWrapper} from './../_lib/storyUtils';
import Bar from '.';

storiesOf('Bar', module)
.addDecorator(withKnobs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
exports[`<Button/> should render correctly. 1`] = `
<button
className="cleanClassName cleanHoverClassName foo className"
disabled={false}
onClick={[Function]}
role="button"
type="button"
Expand Down
Loading