@digigov/react-core 1.0.0-002c630d → 1.0.0-6b93ebf2

package/src/Grid/index.tsx

@@ -4,15 +4,53 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 type GridValues = 'auto' | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
 export interface GridProps extends BaseProps<'div' | 'aside' | 'main'> {
-  container?: boolean;
-  item?: boolean;
-  inline?: boolean;
-  spacing?: 1 | 2 | 4 | 6 | 8 | 10 | 12;
-  xs?: GridValues;
-  sm?: GridValues;
-  md?: GridValues;
-  lg?: GridValues;
-  xl?: GridValues;
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  container?: boolean
+  /**
+  * @value true
+  * @value false
+  * @default true
+  */
+  item?: boolean
+  /**
+  * @value true
+  * @value false
+  */
+  inline?: boolean
+  /**
+  * @value 1
+  * @value 2
+  * @value 4
+  * @value 6
+  * @value 8
+  * @value 10
+  * @value 12
+  */
+  spacing?: 1 | 2 | 4 | 6 | 8 | 10 | 12
+  /**
+
+  */
+  xs?: GridValues
+  /**
+
+  */
+  sm?: GridValues
+  /**
+
+  */
+  md?: GridValues
+  /**
+
+  */
+  lg?: GridValues
+  /**
+
+  */
+  xl?: GridValues
 }
 /**
  * Grid is used to arrange other components in complex grid configurations of rows and columns.

package/src/HeaderLogo/index.tsx

@@ -4,12 +4,14 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HeaderLogoProps extends BaseProps<'a'> {
   /**
-   * src is optional.
-   */
+  * src is optional.
+
+  */
   src?: string;
   /**
-   * href is optional.
-   */
+  * href is optional.
+
+  */
   altText?: string;
 }
 /**

package/src/HeaderSecondaryLogo/index.tsx

@@ -4,12 +4,14 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HeaderSecondaryLogoProps extends BaseProps<'a'> {
   /**
-   * src is needed to provide the url that we get the logo from.
-   */
+  * src is needed to provide the url that we get the logo from.
+
+  */
   src: string;
   /**
-   * href provides the alternative text for the img tag.
-   */
+  * href provides the alternative text for the img tag.
+
+  */
   altText?: string;
 }
 /**

package/src/Heading/index.tsx

@@ -4,14 +4,20 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HeadingProps extends BaseProps<'h1'> {
   /**
-   * size is optional. 'xl' is the default value.
-   * Use 'xl' when this heading is the main page title.
-   */
+  * size is optional. 'xl' is the default value.
+  * Use 'xl' when this heading is the main page title.
+  * @value 'xl'
+  * @value 'lg'
+  * @value 'md'
+  * @value 'sm'
+  * @default 'xl'
+  */
   size?: 'xl' | 'lg' | 'md' | 'sm';
   /**
-   * element is optional. 'h1' is the default value.
-   * Use 'h1' when this heading is the main page title.
-   */
+  * element is optional. 'h1' is the default value.
+  * Use 'h1' when this heading is the main page title.
+
+  */
   element?: HeadingHTMLElements;
 }
 export type HeadingHTMLElements = 'h1' | 'h2' | 'h3' | 'h4';

package/src/HeadingCaption/index.tsx

@@ -4,9 +4,13 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HeadingCaptionProps extends BaseProps<'span'> {
   /**
-   * size is optional. The default value is 'lg'.
-   * This size should be the same as the matching Heading.
-   */
+  * size is optional. The default value is 'lg'.
+  * This size should be the same as the matching Heading.
+  * @value 'xl'
+  * @value 'lg'
+  * @value 'md'
+  * @default 'lg'
+  */
   size?: 'xl' | 'lg' | 'md';
 }
 /**

package/src/HellenicRepublicLogo/index.tsx

@@ -8,9 +8,11 @@ import logoEnInverted from '@digigov/react-core/HellenicRepublicLogo/logo-invert
 
 export interface HellenicRepublicLogoProps extends BaseProps<'img'> {
   /**
-   * lang is optional.
-   * Use this to define the language version of the logo. Default is el.
-   */
+  * lang is optional.
+  * Use this to define the language version of the logo. Default is el.
+  * @value 'el'
+  * @value 'en'
+  */
   lang?: 'el' | 'en';
 }
 /**

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

@@ -0,0 +1,96 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`renders the Hidden with \`lgUp\` props 1`] = `
+<ForwardRef(Hidden)
+  lgUp={true}
+>
+  <ForwardRef(Base)
+    as="div"
+    className="govgr-hidden-lg--up"
+  >
+    <div
+      className="govgr-hidden-lg--up"
+    >
+      <div>
+        hello
+      </div>
+    </div>
+  </ForwardRef(Base)>
+</ForwardRef(Hidden)>
+`;
+
+exports[`renders the Hidden with \`mdUp\` props 1`] = `
+<ForwardRef(Hidden)
+  mdUp={true}
+>
+  <ForwardRef(Base)
+    as="div"
+    className="govgr-hidden-md--up"
+  >
+    <div
+      className="govgr-hidden-md--up"
+    >
+      <div>
+        hello
+      </div>
+    </div>
+  </ForwardRef(Base)>
+</ForwardRef(Hidden)>
+`;
+
+exports[`renders the Hidden with \`smUp\` props 1`] = `
+<ForwardRef(Hidden)
+  smUp={true}
+>
+  <ForwardRef(Base)
+    as="div"
+    className="govgr-hidden-sm--up"
+  >
+    <div
+      className="govgr-hidden-sm--up"
+    >
+      <div>
+        hello
+      </div>
+    </div>
+  </ForwardRef(Base)>
+</ForwardRef(Hidden)>
+`;
+
+exports[`renders the Hidden with \`xlUp\` props 1`] = `
+<ForwardRef(Hidden)
+  xlUp={true}
+>
+  <ForwardRef(Base)
+    as="div"
+    className="govgr-hidden-xl--up"
+  >
+    <div
+      className="govgr-hidden-xl--up"
+    >
+      <div>
+        hello
+      </div>
+    </div>
+  </ForwardRef(Base)>
+</ForwardRef(Hidden)>
+`;
+
+exports[`renders the Hidden with \`xsUp\` props 1`] = `
+<ForwardRef(Hidden)
+  xsUp={true}
+>
+  <ForwardRef(Base)
+    as="div"
+    className="govgr-hidden-xs--up"
+  >
+    <div
+      className="govgr-hidden-xs--up"
+    >
+      <div>
+        hello
+      </div>
+    </div>
+  </ForwardRef(Base)>
+</ForwardRef(Hidden)>
+`;

package/src/Hidden/index.tsx

@@ -3,11 +3,36 @@ import clsx from 'clsx';
 import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HiddenProps extends BaseProps<'div'> {
-  lgUp?: boolean;
-  mdUp?: boolean;
-  smUp?: boolean;
-  xlUp?: boolean;
-  xsUp?: boolean;
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  xsUp?: boolean
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  smUp?: boolean
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  mdUp?: boolean
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  lgUp?: boolean
+  /**
+  * @value true
+  * @value false
+  * @default false
+  */
+  xlUp?: boolean
 }
 /**
  * Hidden is used to responsively hide children based on the screen size.
@@ -19,11 +44,11 @@ export const Hidden = React.forwardRef<HTMLDivElement, HiddenProps>(
     {
       className,
       children,
-      lgUp = false,
-      mdUp = false,
-      smUp = false,
-      xlUp = false,
       xsUp = false,
+      smUp,
+      mdUp,
+      lgUp,
+      xlUp,
       ...props
     },
     ref

package/src/Hint/index.tsx

@@ -4,9 +4,12 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface HintProps extends BaseProps<'p'> {
   /**
-   * fontSize is optional.
-   * You can add this fontSize override prop in order to change the font size.
-   */
+  * fontSize is optional.
+  * You can add this fontSize override prop in order to change the font size.
+  * @value '14'
+  * @value '16'
+  * @value '24'
+  */
   fontSize?: '14' | '16' | '24';
 }
 /**

package/src/KitchenSinkContent/index.tsx

@@ -4,10 +4,13 @@ import { Base, BaseProps } from '@digigov/react-core/Base';
 
 export interface KitchenSinkContentProps extends BaseProps<'div'> {
   /**
-   * The content of the component.
-   *
-   *
-   * */
+  * The content of the component.
+  *
+  *
+  * * @value true
+  * @value false
+  * @default false
+  */
   wide?: boolean;
 }
 

package/src/LabelTitle/index.tsx

@@ -4,14 +4,21 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface LabelFieldProps extends BaseProps<'span'> {
   /**
-   * size is optional. The default value is 'lg'
-   */
+  * size is optional. The default value is 'lg'
+  * @value 'xl'
+  * @value 'lg'
+  * @value 'md'
+  * @value 'sm'
+  */
   size?: 'xl' | 'lg' | 'md' | 'sm';
   /**
-   * heading is optional.
-   * Add this prop if this Field component is the only one in this page.
-   * The default value is false.
-   */
+  * heading is optional.
+  * Add this prop if this Field component is the only one in this page.
+  * The default value is false.
+  * @value true
+  * @value false
+  * @default false
+  */
   heading?: boolean;
 }
 /**

package/src/LabeledText/index.tsx

@@ -4,9 +4,11 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface LabeledTextProps extends BaseProps<'span'> {
   /**
-   * Set active true when the label is focused. Default value is false.
-   * If the active property is being set to true the background color is yellow otherwise it's light grey.
-   */
+  * Set active true when the label is focused. Default value is false.
+  * If the active property is being set to true the background color is yellow otherwise it's light grey.
+  * @value true
+  * @value false
+  */
   active?: boolean;
 }
 /**

package/src/Layout/index.tsx

@@ -3,7 +3,12 @@ import clsx from 'clsx';
 import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface LayoutProps extends BaseProps<'div'> {
-  fullHeight?: boolean;
+  /**
+  * @value true
+  * @value false
+  * @default true
+  */
+  fullHeight?: boolean
 }
 /**
  * Wrapper component for the entire page except the Header and the Footer.

package/src/LinkBase/index.tsx

@@ -4,23 +4,25 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface LinkBaseProps extends BaseProps<'a'> {
   /**
-   * underline is optional. The default value is 'true'.
-   * Make it 'false' only if the context tells the user that the text is a link, even without the underline.
-   */
+  * underline is optional. The default value is 'true'.
+  * Make it 'false' only if the context tells the user that the text is a link, even without the underline.
+  * @value true
+  * @value false
+  */
   underline?: boolean;
 }
 /**
  * This component defines a hyperlink, which is used to link from one page to another.
  */
 export const LinkBase = React.forwardRef<HTMLAnchorElement, LinkBaseProps>(
-  function LinkBase({ underline, className, children, ...props }, ref) {
+  function LinkBase({ underline = true, className, children, ...props }, ref) {
     return (
       <Base
         as="a"
         ref={ref}
         className={clsx(className, {
           'govgr-link': true,
-          'govgr-link--no-underline': underline === false,
+          'govgr-link--no-underline': !underline,
         })}
         {...props}
       >

package/src/List/index.tsx

@@ -4,16 +4,25 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface ListProps extends BaseProps<'ol'> {
   /**
-   * listStyle is optional. By default, the list style is none.
-   */
+  * listStyle is optional. By default, the list style is none.
+  * @value 'bullet'
+  * @value 'number'
+  * @value 'none'
+  * @default 'none'
+  */
   listStyle?: 'bullet' | 'number' | 'none';
   /**
-   * spaced is optional. Use it to add space between the list items.
-   */
+  * spaced is optional. Use it to add space between the list items.
+  * @value true
+  * @value false
+  * @default false
+  */
   spaced?: boolean;
   /**
-   * horizontal is optional. Use it to display the list items horizontally.
-   */
+  * horizontal is optional. Use it to display the list items horizontally.
+  * @value true
+  * @value false
+  */
   horizontal?: boolean;
 }
 /**

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

@@ -4,10 +4,10 @@ exports[`renders the LoaderContainer with no props 1`] = `
 <ForwardRef(LoaderContainer)>
   <ForwardRef(Base)
     as="div"
-    className="govgr-loader__container"
+    className="govgr-loader"
   >
     <div
-      className="govgr-loader__container"
+      className="govgr-loader"
     />
   </ForwardRef(Base)>
 </ForwardRef(LoaderContainer)>

package/src/LoaderContainer/index.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import Base, { BaseProps } from '@digigov/react-core/Base';
 
-export interface LoaderContainerProps extends BaseProps<'div'> {}
+export interface LoaderContainerProps extends BaseProps<'div'> { }
 /**
  * LoaderContainer contains the svg icon that is being displayed in the page and works as a loading indicator.
  */
@@ -15,7 +15,7 @@ export const LoaderContainer = React.forwardRef<
       as="div"
       ref={ref}
       className={clsx(className, {
-        'govgr-loader__container': true,
+        'govgr-loader': true,
       })}
       {...props}
     >

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

@@ -3,14 +3,14 @@
 exports[`renders the Masthead with no props 1`] = `
 <ForwardRef(Masthead)>
   <ForwardRef(Base)
-    as="div"
+    as="section"
     className="govgr-background-dark govgr-masthead--primary govgr-masthead"
   >
-    <div
+    <section
       className="govgr-background-dark govgr-masthead--primary govgr-masthead"
     >
       hello
-    </div>
+    </section>
   </ForwardRef(Base)>
 </ForwardRef(Masthead)>
 `;

package/src/Masthead/index.tsx

@@ -2,12 +2,15 @@ import React from 'react';
 import clsx from 'clsx';
 import Base, { BaseProps } from '@digigov/react-core/Base';
 
-export interface MastheadProps extends BaseProps<'div'> {
+export interface MastheadProps extends BaseProps<'section'> {
   /**
-   *
-   * color prop changes the background color of MastHead component.
-   * default value is primary.
-   */
+  *
+  * color prop changes the background color of MastHead component.
+  * default value is primary.
+  * @value 'primary'
+  * @value 'secondary'
+  * @default 'primary'
+  */
   color?: 'primary' | 'secondary';
 }
 /**
@@ -17,7 +20,7 @@ export const Masthead = React.forwardRef<HTMLDivElement, MastheadProps>(
   function Masthead({ className, children, color = 'primary', ...props }, ref) {
     return (
       <Base
-        as="div"
+        as="section"
         ref={ref}
         className={clsx(className, {
           'govgr-masthead': true,

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

@@ -0,0 +1,16 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`renders the MastheadLogo with no props 1`] = `
+<ForwardRef(MastheadLogo)>
+  <ForwardRef(Base)
+    alt="masthead logo"
+    as="img"
+    className="govgr-masthead__logo"
+  >
+    <img
+      alt="masthead logo"
+      className="govgr-masthead__logo"
+    />
+  </ForwardRef(Base)>
+</ForwardRef(MastheadLogo)>
+`;

package/src/ModalContainer/index.tsx

@@ -3,7 +3,11 @@ import clsx from 'clsx';
 import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface ModalContainerProps extends BaseProps<'div'> {
-  open?: boolean;
+  /**
+  * @value true
+  * @value false
+  */
+  open?: boolean
 }
 /**
  * Modals can be used to open a pop-up dialog box and provide critical information

package/src/Nav/index.tsx

@@ -4,30 +4,45 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface NavProps extends BaseProps<'nav'> {
   /**
-   * active is optional.
-   * active prop add background color to navigation link.
-   * use this prop only for header navigation;
-   */
+  * active is optional.
+  * active prop add background color to navigation link.
+  * use this prop only for header navigation;
+  * @value true
+  * @value false
+  * @default false
+  */
   open?: boolean;
   /**
-   * layout prop sets the display layout for the nav list
-   * layout is horizontal by default.
-   */
+  * layout prop sets the display layout for the nav list
+  * layout is horizontal by default.
+  * @value 'vertical'
+  * @value 'horizontal'
+  * @default 'horizontal'
+  */
   layout?: 'vertical' | 'horizontal';
   /**
-   * hidden is optional.
-   * hidden prop hides the nav element when it is called from a navItem.
-   */
+  * hidden is optional.
+  * hidden prop hides the nav element when it is called from a navItem.
+  * @value true
+  * @value false
+  * @default false
+  */
   hidden?: boolean;
   /**
-   * fixed is optional.
-   * fixed prop allows element to be positioned relative to the viewport
-   */
+  * fixed is optional.
+  * fixed prop allows element to be positioned relative to the viewport
+  * @value true
+  * @value false
+  * @default true
+  */
   fixed?: boolean;
   /**
-   * border is optional.
-   * border prop contains border-bottom styling.
-   */
+  * border is optional.
+  * border prop contains border-bottom styling.
+  * @value true
+  * @value false
+  * @default true
+  */
   border?: boolean;
 }
 /**

package/src/NavList/index.tsx

@@ -4,9 +4,12 @@ import Base, { BaseProps } from '@digigov/react-core/Base';
 
 export interface NavListProps extends BaseProps<'ul'> {
   /**
-   * active prop sets active background color to the nav list.
-   * active is false by default.
-   */
+  * active prop sets active background color to the nav list.
+  * active is false by default.
+  * @value true
+  * @value false
+  * @default false
+  */
   active?: boolean;
 }
 /**