@digigov/react-core 1.0.0-002c630d → 1.0.0-21c8c3dc

package/src/TextInput/index.test.tsx

@@ -7,250 +7,250 @@ it('renders the TextInput with no props', () => {
   expect(mount(<TextInput></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2', () => {
-  expect(mount(<TextInput characterWidth={2}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="2-char"', () => {
+  expect(mount(<TextInput maxWidth='2-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3', () => {
-  expect(mount(<TextInput characterWidth={3}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="3-char"', () => {
+  expect(mount(<TextInput maxWidth='3-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4', () => {
-  expect(mount(<TextInput characterWidth={4}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="4-char"', () => {
+  expect(mount(<TextInput maxWidth='4-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=5', () => {
-  expect(mount(<TextInput characterWidth={5}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="5-char"', () => {
+  expect(mount(<TextInput maxWidth='5-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=10', () => {
-  expect(mount(<TextInput characterWidth={10}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="10-char"', () => {
+  expect(mount(<TextInput maxWidth='10-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20', () => {
-  expect(mount(<TextInput characterWidth={20}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with maxWidth="20-char"', () => {
+  expect(mount(<TextInput maxWidth='20-char'></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=one-quarter', () => {
+it('renders the TextInput with width=one-quarter', () => {
   expect(
-    mount(<TextInput cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=one-third', () => {
+it('renders the TextInput with width=one-third', () => {
   expect(
-    mount(<TextInput cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=one-half', () => {
+it('renders the TextInput with width=one-half', () => {
   expect(
-    mount(<TextInput cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=two-thirds', () => {
+it('renders the TextInput with width=two-thirds', () => {
   expect(
-    mount(<TextInput cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=three-quarters', () => {
+it('renders the TextInput with width=three-quarters', () => {
   expect(
-    mount(<TextInput cellWidth={'three-quarters'}></TextInput>)
+    mount(<TextInput width={'75%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with cellWidth=full', () => {
-  expect(mount(<TextInput cellWidth={'full'}></TextInput>)).toMatchSnapshot();
+it('renders the TextInput with width=full', () => {
+  expect(mount(<TextInput width={'full'}></TextInput>)).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=one-quarter', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=one-quarter', () => {
   expect(
-    mount(<TextInput characterWidth={2} cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput maxWidth='2-char' width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=one-quarter', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=one-quarter', () => {
   expect(
-    mount(<TextInput characterWidth={3} cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput maxWidth='3-char' width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=one-quarter', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=one-quarter', () => {
   expect(
-    mount(<TextInput characterWidth={4} cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput maxWidth='4-char' width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=one-quarter', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=one-quarter', () => {
   expect(
-    mount(<TextInput characterWidth={5} cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput maxWidth='5-char' width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=one-quarter', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=one-quarter', () => {
   expect(
-    mount(<TextInput characterWidth={20} cellWidth={'one-quarter'}></TextInput>)
+    mount(<TextInput maxWidth='20-char' width={'25%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=one-third', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=one-third', () => {
   expect(
-    mount(<TextInput characterWidth={2} cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput maxWidth='2-char' width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=one-third', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=one-third', () => {
   expect(
-    mount(<TextInput characterWidth={3} cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput maxWidth='3-char' width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=one-third', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=one-third', () => {
   expect(
-    mount(<TextInput characterWidth={4} cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput maxWidth='4-char' width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=one-third', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=one-third', () => {
   expect(
-    mount(<TextInput characterWidth={5} cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput maxWidth='5-char' width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=one-third', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=one-third', () => {
   expect(
-    mount(<TextInput characterWidth={20} cellWidth={'one-third'}></TextInput>)
+    mount(<TextInput maxWidth='20-char' width={'33.3%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=one-half', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=one-half', () => {
   expect(
-    mount(<TextInput characterWidth={2} cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput maxWidth='2-char' width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=one-half', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=one-half', () => {
   expect(
-    mount(<TextInput characterWidth={3} cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput maxWidth='3-char' width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=one-half', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=one-half', () => {
   expect(
-    mount(<TextInput characterWidth={4} cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput maxWidth='4-char' width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=one-half', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=one-half', () => {
   expect(
-    mount(<TextInput characterWidth={5} cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput maxWidth='5-char' width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=one-half', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=one-half', () => {
   expect(
-    mount(<TextInput characterWidth={20} cellWidth={'one-half'}></TextInput>)
+    mount(<TextInput maxWidth='20-char' width={'50%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=two-thirds', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=two-thirds', () => {
   expect(
-    mount(<TextInput characterWidth={2} cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput maxWidth='2-char' width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=two-thirds', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=two-thirds', () => {
   expect(
-    mount(<TextInput characterWidth={3} cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput maxWidth='3-char' width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=two-thirds', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=two-thirds', () => {
   expect(
-    mount(<TextInput characterWidth={4} cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput maxWidth='4-char' width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=two-thirds', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=two-thirds', () => {
   expect(
-    mount(<TextInput characterWidth={5} cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput maxWidth='5-char' width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=two-thirds', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=two-thirds', () => {
   expect(
-    mount(<TextInput characterWidth={20} cellWidth={'two-thirds'}></TextInput>)
+    mount(<TextInput maxWidth='20-char' width={'66.6%'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=three-quarters', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=three-quarters', () => {
   expect(
     mount(
-      <TextInput characterWidth={2} cellWidth={'three-quarters'}></TextInput>
+      <TextInput maxWidth='2-char' width={'75%'}></TextInput>
     )
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=three-quarters', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=three-quarters', () => {
   expect(
     mount(
-      <TextInput characterWidth={3} cellWidth={'three-quarters'}></TextInput>
+      <TextInput maxWidth='3-char' width={'75%'}></TextInput>
     )
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=three-quarters', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=three-quarters', () => {
   expect(
     mount(
-      <TextInput characterWidth={4} cellWidth={'three-quarters'}></TextInput>
+      <TextInput maxWidth='4-char' width={'75%'}></TextInput>
     )
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=three-quarters', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=three-quarters', () => {
   expect(
     mount(
-      <TextInput characterWidth={5} cellWidth={'three-quarters'}></TextInput>
+      <TextInput maxWidth='5-char' width={'75%'}></TextInput>
     )
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=three-quarters', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=three-quarters', () => {
   expect(
     mount(
-      <TextInput characterWidth={20} cellWidth={'three-quarters'}></TextInput>
+      <TextInput maxWidth='20-char' width={'75%'}></TextInput>
     )
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=2 and with cellWidth=full', () => {
+it('renders the TextInput with maxWidth="2-char" and with width=full', () => {
   expect(
-    mount(<TextInput characterWidth={2} cellWidth={'full'}></TextInput>)
+    mount(<TextInput maxWidth='2-char' width={'full'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=3 and with cellWidth=full', () => {
+it('renders the TextInput with maxWidth="3-char" and with width=full', () => {
   expect(
-    mount(<TextInput characterWidth={3} cellWidth={'full'}></TextInput>)
+    mount(<TextInput maxWidth='3-char' width={'full'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=4 and with cellWidth=full', () => {
+it('renders the TextInput with maxWidth="4-char" and with width=full', () => {
   expect(
-    mount(<TextInput characterWidth={4} cellWidth={'full'}></TextInput>)
+    mount(<TextInput maxWidth='4-char' width={'full'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput  with with characterWidth=5 with cellWidth=full', () => {
+it('renders the TextInput  with with maxWidth="5-char" with width=full', () => {
   expect(
-    mount(<TextInput characterWidth={5} cellWidth={'full'}></TextInput>)
+    mount(<TextInput maxWidth='5-char' width={'full'}></TextInput>)
   ).toMatchSnapshot();
 });
 
-it('renders the TextInput with characterWidth=20 and with cellWidth=full', () => {
+it('renders the TextInput with maxWidth="20-char" and with width=full', () => {
   expect(
-    mount(<TextInput characterWidth={20} cellWidth={'full'}></TextInput>)
+    mount(<TextInput maxWidth='20-char' width={'full'}></TextInput>)
   ).toMatchSnapshot();
 });

package/src/TextInput/index.tsx

@@ -4,25 +4,34 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface TextInputProps extends BaseProps<'input'> {
   /**
-   * characterWidth is optional.
+   * maxWidth is optional.
+   * @value '2-char';
+   * @value '3-char';
+   * @value '4-char';
+   * @value '5-char';
+   * @value '10-char';
+   * @value '20-char';
    */
-  characterWidth?: 2 | 3 | 4 | 5 | 10 | 20;
+  maxWidth?: '2-char' | '3-char' | '4-char' | '5-char' | '10-char' | '20-char';
 
   /**
-   * cellWidth is optional.
-   * Use cellWidth prop to define a custom width for a specific reference number in your components.
+   * width is optional.
+   * Use width prop to define a custom width in your component.
+   * @value '25%';
+   * @value '33.3%';
+   * @value '50%';
+   * @value '66.6%';
+   * @value '75%';
+   * @value '100%';
+   * @value 'full';
    */
-  cellWidth?:
-    | 'one-quarter'
-    | 'one-third'
-    | 'one-half'
-    | 'two-thirds'
-    | 'three-quarters'
-    | 'full';
+  width?: '25%' | '33.3%' | '50%' | '66.6%' | '75%' | '100%' | 'full';
 
   /**
    * error is optional. The default value is false.
    * Use this prop when there is an error at the input.
+   * @value true
+   * @value false
    */
   error?: boolean;
 }
@@ -34,9 +43,8 @@ export const TextInput = React.forwardRef<HTMLInputElement, TextInputProps>(
   function TextInput(
     {
       type = 'text',
-      name,
-      characterWidth,
-      cellWidth,
+      maxWidth,
+      width,
       error,
       className,
       children,
@@ -48,23 +56,16 @@ export const TextInput = React.forwardRef<HTMLInputElement, TextInputProps>(
       <Base
         as="input"
         type={type}
-        name={name}
         ref={ref}
         className={clsx(className, {
           'govgr-input': true,
-          'govgr-input--width-2': characterWidth === 2,
-          'govgr-input--width-3': characterWidth === 3,
-          'govgr-input--width-4': characterWidth === 4,
-          'govgr-input--width-5': characterWidth === 5,
-          'govgr-input--width-10': characterWidth === 10,
-          'govgr-input--width-20': characterWidth === 20,
-          'govgr-!-width-one-quarter': cellWidth === 'one-quarter',
-          'govgr-!-width-one-third': cellWidth === 'one-third',
-          'govgr-!-width-one-half': cellWidth === 'one-half',
-          'govgr-!-width-two-thirds': cellWidth === 'two-thirds',
-          'govgr-!-width-three-quarters': cellWidth === 'three-quarters',
-          'govgr-!-width-full': cellWidth === 'full',
           'govgr-input--error': error,
+          [`govgr-input--width-${maxWidth}`]: maxWidth !== undefined,
+          'govgr-!-width-one-quarter': width === '25%',
+          'govgr-!-width-one-third': width === '33.3%',
+          'govgr-!-width-one-half': width === '50%',
+          'govgr-!-width-two-thirds': width === '66.6%',
+          'govgr-!-width-three-quarters': width === '75%',
         })}
         {...props}
       >

package/src/Timeline/__snapshots__/index.test.tsx.snap

@@ -1,5 +1,22 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`renders the Timeline with dense prop 1`] = `
+<ForwardRef(Timeline)
+  dense={true}
+>
+  <ForwardRef(Base)
+    as="ol"
+    className="govgr-timeline--dense govgr-timeline"
+  >
+    <ol
+      className="govgr-timeline--dense govgr-timeline"
+    >
+      hello
+    </ol>
+  </ForwardRef(Base)>
+</ForwardRef(Timeline)>
+`;
+
 exports[`renders the Timeline with no prop 1`] = `
 <ForwardRef(Timeline)>
   <ForwardRef(Base)

package/src/Timeline/index.test.tsx

@@ -6,3 +6,7 @@ import Timeline from '@digigov/react-core/Timeline';
 it('renders the Timeline with no prop', () => {
   expect(mount(<Timeline>hello</Timeline>)).toMatchSnapshot();
 });
+
+it('renders the Timeline with dense prop', () => {
+  expect(mount(<Timeline dense>hello</Timeline>)).toMatchSnapshot();
+});

package/src/Timeline/index.tsx

@@ -4,23 +4,26 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface TimelineProps extends BaseProps<'ol'> {
   /**
-   * spaced is optional. Use it to add space between the list items.
+   * dense is optional.
+   * @value true Timeline will be dense.
+   * @value false
+   * @default true
    */
-  spaced?: boolean;
+  dense?: boolean;
 }
 /**
  * Timeline component is used for listing items.
  * This component must contain TimelineItem component.
  */
 export const Timeline = React.forwardRef<HTMLOListElement, TimelineProps>(
-  function Timeline({ spaced = false, className, children, ...props }, ref) {
+  function Timeline({ dense, className, children, ...props }, ref) {
     return (
       <Base
         as="ol"
         ref={ref}
         className={clsx(className, {
           'govgr-timeline': true,
-          'govgr-timeline--spaced': spaced,
+          'govgr-timeline--dense': dense,
         })}
         {...props}
       >

package/src/TimelineHeading/index.tsx

@@ -4,12 +4,19 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface TimelineHeadingProps extends BaseProps<'h2'> {
   /**
-   * size is optional. 'lg' is the default value.
-   */
+  * size is optional. 'lg' is the default value.
+  * @value 'lg'
+  * @value 'md'
+  * @value 'sm'
+  * @default 'lg'
+  */
   size?: 'lg' | 'md' | 'sm';
   /**
-   * element is optional. 'h2' is the default value.
-   */
+  * element is optional. 'h2' is the default value.
+  * @value 'h2'
+  * @value 'h3'
+  * @value 'h4'
+  */
   element?: 'h2' | 'h3' | 'h4';
 }