Skip to content

docs: Call out FormInput's props explicitly #471

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.

Sign up for GitHub

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

Merged
greg-a-smith merged 2 commits into from
Mar 20, 2019
Merged

docs: Call out FormInput's props explicitly #471

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93f8967
Call out props for FormInput
truclyle Mar 18, 2019
881227d
Call out FormInput PropTypes and PropDescriptions
truclyle Mar 19, 2019
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
23 changes: 19 additions & 4 deletions src/Forms/FormInput.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { INPUT_TYPES } from '../utils/constants';
import PropTypes from 'prop-types';
import React from 'react';

const FormInput = ({ state, className, ...props }) => {
const FormInput = ({ state, className, disabled, id, name, placeholder, readOnly, type, value, ...props }) => {
const formInputClasses = classnames(
'fd-form__control',
{
Expand All @@ -15,7 +15,14 @@ const FormInput = ({ state, className, ...props }) => {
return (
<input
{...props}
className={formInputClasses} />
className={formInputClasses}
disabled={disabled}
id={id}
name={name}
placeholder={placeholder}
readOnly={readOnly}
type={type}
value={value} />
);
};

Expand All @@ -24,12 +31,20 @@ FormInput.displayName = 'FormInput';
FormInput.propTypes = {
className: PropTypes.string,
disabled: PropTypes.bool,
id: PropTypes.string,
name: PropTypes.string,
placeholder: PropTypes.string,
readOnly: PropTypes.bool,
state: PropTypes.oneOf(INPUT_TYPES)
state: PropTypes.oneOf(INPUT_TYPES),
type: PropTypes.string,
value: PropTypes.string
};

Copy link
Contributor

@bcullman bcullman Mar 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prop description should be provided for all non default props seen here:

https://github.com/SAP/fundamental-react/blob/master/src/_playground/documentation/Properties/defaults.js

FormInput.propDescriptions = {
state: 'Sets the state of the input. Can be left empty for default styles.'
name: 'Value for the `name` attribute on the input.',
state: 'Sets the state of the input. Can be left empty for default styles.',
type: 'Value for the `type` attribute on the input.',
value: 'Value for the `value` attribute on the input.'
};

export default FormInput;