update Fields to support description and detail props - update inputText to have width 100% to accommodate the changes (#540)

* first commit

* issue with filed props

* update Fields to support description and details update inputText to have width of 100%

* Tweak for InputText width

* ready for review

* update to make stylelint happy

* update snapshots

* restore playground index jsx

* Field label widths

* ready for review

* after review

Co-authored-by: Luke Bowerman <[email protected]>
Co-authored-by: Daniel Christopher <[email protected]>

Author: 3 people

packages/components/src/Form/Fields/Field.tsx

@@ -24,8 +24,7 @@
 
  */
 
-import { WidthProperty } from 'csstype'
-import React, { FunctionComponent } from 'react'
+import React, { FunctionComponent, ReactNode } from 'react'
 import styled, { css } from 'styled-components'
 import { ResponsiveValue, TLengthStyledSystem } from 'styled-system'
 import {
@@ -39,22 +38,24 @@ import pick from 'lodash/pick'
 import { FlexItem } from '../../Layout/FlexItem'
 import { FormControl, FormControlDirections } from '../FormControl/FormControl'
 import { Label } from '../Label/Label'
+import { Text } from '../../Text/Text'
+import { Paragraph } from '../../Text/Paragraph'
 import {
   ValidationMessage,
   ValidationMessageProps,
 } from '../ValidationMessage/ValidationMessage'
+import { Flex } from '../../Layout'
+import { InputText, Select } from '../Inputs'
 
 type ResponsiveSpaceValue = ResponsiveValue<TLengthStyledSystem>
 
 export interface CustomizableFieldAttributesInterface
   extends CustomizableAttributes {
   labelMargin: SpacingSizes
-  labelWidth: ResponsiveValue<WidthProperty<TLengthStyledSystem>>
 }
 
 export const CustomizableFieldAttributes: CustomizableFieldAttributesInterface = {
   labelMargin: 'xsmall',
-  labelWidth: '20%',
 }
 
 export interface FieldProps {
@@ -66,6 +67,14 @@ export interface FieldProps {
    * Determines where to place the validation message in relation to the input.
    */
   alignValidationMessage?: FormControlDirections
+  /*
+   * optional extra description
+   */
+  description?: ReactNode
+  /**
+   * notes and details added to the top right corner of the field
+   */
+  detail?: ReactNode
   /**
    * Id of the input element to match a label to.
    */
@@ -96,17 +105,25 @@ export interface FieldProps {
    * Holds the type of validation (error, warning, etc.) and corresponding message.
    */
   validationMessage?: ValidationMessageProps
+  /**
+   *
+   * Specify the width of the FieldText if different then 13rem
+   */
+  width?: ResponsiveSpaceValue
 }
 
 export const fieldPropKeys = [
   'alignLabel',
   'alignValidationMessage',
+  'description',
+  'detail',
   'id',
   'label',
   'labelFontSize',
   'labelFontWeight',
   'labelWidth',
   'validationMessage',
+  'width',
 ]
 
 export const pickFieldProps = (props: FieldProps) =>
@@ -119,8 +136,9 @@ const RequiredStar = styled(props => (
     *
   </span>
 ))`
-  color: ${props => props.theme.colors.semanticColors.danger.darker};
+  color: ${props => props.theme.colors.palette.red500};
 `
+
 const handleHorizontalAlignment = (props: FieldProps) => {
   const { alignLabel, labelWidth } = props
   const width = labelWidth || CustomizableFieldAttributes.labelWidth
@@ -170,20 +188,30 @@ const getValidationMessageAlignment = (
 const FieldComponent: FunctionComponent<FieldProps> = ({
   alignValidationMessage,
   children,
+  description,
+  detail,
   id,
   label,
   labelFontSize,
   labelFontWeight,
   required,
   validationMessage,
+  width,
   ...props
 }) => {
   return (
     <FormControl mb="xsmall" {...props}>
-      <Label htmlFor={id} fontWeight={labelFontWeight} fontSize={labelFontSize}>
-        {label}
-        {required && <RequiredStar />}
-      </Label>
+      <Flex alignItems="left" justifyContent="space-between" width={width}>
+        <Label
+          htmlFor={id}
+          fontWeight={labelFontWeight}
+          fontSize={labelFontSize}
+        >
+          {label}
+          {required && <RequiredStar />}
+        </Label>
+        {detail && <Text fontSize="xsmall">{detail}</Text>}
+      </Flex>
       <FormControl
         alignLabel={getValidationMessageAlignment(alignValidationMessage)}
         mb="xsmall"
@@ -196,11 +224,26 @@ const FieldComponent: FunctionComponent<FieldProps> = ({
           />
         ) : null}
       </FormControl>
+      {description && (
+        <Paragraph mt="none" fontSize="xsmall">
+          {description}
+        </Paragraph>
+      )}
     </FormControl>
   )
 }
 
 export const Field = styled(FieldComponent)`
+  width: ${props => props.width};
+
+  ${InputText} {
+    width: 100%;
+  }
+
+  ${Select} {
+    width: 100%;
+  }
+
   ${Label} {
     ${handleHorizontalAlignment}
   }

packages/components/src/Form/Fields/FieldCheckbox/FieldCheckbox.tsx

@@ -3,17 +3,17 @@
  MIT License
 
  Copyright (c) 2019 Looker Data Sciences, Inc.
- 
+
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
- 
+
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
- 
+
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -31,7 +31,9 @@ import { useFormContext } from '../../Form'
 import { Checkbox, CheckboxProps } from '../../Inputs/Checkbox/Checkbox'
 import { Field, FieldProps, omitFieldProps, pickFieldProps } from '../Field'
 
-export interface FieldCheckboxProps extends FieldProps, CheckboxProps {}
+export interface FieldCheckboxProps
+  extends CheckboxProps,
+    Omit<FieldProps, 'description' | 'detail'> {}
 
 const FieldCheckboxComponent = forwardRef(
   (props: FieldCheckboxProps, ref: Ref<HTMLInputElement>) => {