@newtonschool/grauity 0.0.3 → 0.0.9

package/dist/index.d.ts

@@ -1,7 +1,170 @@
-import './css/index.scss';
-export { ICON_TAGS, TAG_ICONS } from './core';
-export type { GrauityInitProps } from './init';
-export { GrauityInit } from './init';
-export type { IconProps } from './elements';
-export { Icon } from './elements';
-//# sourceMappingURL=index.d.ts.map
+import * as React from "react";
+type grauityIconSizeName = '4' | '8' | '12' | '16' | '20' | '24' | '28' | '32' | '36' | '40';
+type grauityIconColorName = 'white' | 'black' | 'grey' | 'blue' | 'red' | 'green' | 'orange' | 'yellow' | 'purple';
+type grauityIconName = 'school-left' | 'school' | 'code' | 'today' | 'person';
+export const ICON_TAGS: {
+    "school-left": string[];
+    school: string[];
+    code: string[];
+    today: string[];
+    person: string[];
+};
+export const TAG_ICONS: {
+    buildings: string[];
+    code: string[];
+    objects: string[];
+    states: string[];
+    calendar: string[];
+    usersAndPeople: string[];
+};
+type grauityFlippedChoiceName = 'vertically' | 'horizontally';
+type grauityRotatedChoiceName = 'clockwise' | 'counterclockwise';
+export interface GrauityInitProps {
+    /**
+     * An element type to render as (string or function).
+     * */
+    as: React.ElementType;
+    /**
+     * The font size to be applied on this element and so will act as standard for the `ems` of all grauity components.
+     * */
+    fontSize: string;
+    /**
+     * The multiplier is multiplied will all the `ems` of the grauity components.
+     * */
+    multiplier?: number;
+    /**
+     * The children to be rendered inside this component.
+     * */
+    children?: React.ReactNode;
+}
+/**
+ * This component is used to initialize the Grauity library. Ideally, it should be the root component of your application.
+ * But nonetheless all the grauity components should be the children of this component.
+ * */
+export function GrauityInit({ as, fontSize, multiplier, children }: GrauityInitProps): JSX.Element;
+declare namespace GrauityInit {
+    var propTypes: {
+        as: PropTypes.Requireable<PropTypes.ReactComponentLike>;
+        fontSize: PropTypes.Requireable<string>;
+        multiplier: PropTypes.Requireable<number>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    };
+    var defaultProps: {
+        as: string;
+        fontSize: string;
+        multiplier: number;
+        children: any;
+    };
+}
+export interface IconProps {
+    /**
+     * Icon can have the aria hidden attribute
+     * */
+    ariaHidden?: string;
+    /**
+     * Icon can have the aria label attribute
+     * */
+    ariaLabel?: string;
+    /**
+     * An element type to render as (string or function).
+     * */
+    as?: React.ElementType;
+    /**
+     * Format the icon to appear bordered
+     * */
+    bordered?: boolean;
+    /**
+     * Format the icon to appear circular
+     * */
+    circular?: boolean;
+    /**
+     * Color of the icon
+     * */
+    color?: grauityIconColorName;
+    /**
+     * Additional classes to be added to the component
+     * */
+    className?: string;
+    /**
+     * Show that the icon is inactive
+     * */
+    disabled?: boolean;
+    /**
+     * Fitted, without space to left or right of Icon
+     * */
+    fitted?: boolean;
+    /**
+     * Icon can be flipped
+     * */
+    flipped?: grauityFlippedChoiceName;
+    /**
+     * The colors of the icon can be inverted in case of used with border
+     * * */
+    inverted?: boolean;
+    /**
+     * Icon can be formatted as a link
+     * */
+    link?: boolean;
+    /**
+     * Icon can be used as a simple loader
+     * */
+    loading?: boolean;
+    /**
+     * Name of the icon
+     * */
+    name: grauityIconName;
+    /**
+     * Icon can be rotated
+     * */
+    rotated?: grauityRotatedChoiceName;
+    /**
+     * Size of the icon
+     * */
+    size?: grauityIconSizeName;
+    /**
+     * Additional styles to be used over the element
+     * */
+    style?: React.CSSProperties;
+}
+export function Icon({ ariaHidden, ariaLabel, as, bordered, circular, color, className, disabled, fitted, flipped, inverted, link, loading, name, rotated, size, style, ...props }: IconProps): JSX.Element;
+declare namespace Icon {
+    var propTypes: {
+        ariaHidden: PropTypes.Requireable<string>;
+        ariaLabel: PropTypes.Requireable<string>;
+        as: PropTypes.Requireable<PropTypes.ReactComponentLike>;
+        bordered: PropTypes.Requireable<boolean>;
+        circular: PropTypes.Requireable<boolean>;
+        color: PropTypes.Requireable<import("core").GRAUITY_COLOR>;
+        className: PropTypes.Requireable<string>;
+        disabled: PropTypes.Requireable<boolean>;
+        fitted: PropTypes.Requireable<boolean>;
+        flipped: PropTypes.Requireable<import("core/miscellaneous-choices").GRAUITY_FLIPPED_CHOICES>;
+        inverted: PropTypes.Requireable<boolean>;
+        link: PropTypes.Requireable<boolean>;
+        loading: PropTypes.Requireable<boolean>;
+        name: PropTypes.Validator<string>;
+        rotated: PropTypes.Requireable<import("core/miscellaneous-choices").GRAUITY_ROTATED_CHOICES>;
+        size: PropTypes.Requireable<import("core").GRAUITY_SIZE>;
+        style: PropTypes.Requireable<object>;
+    };
+    var defaultProps: {
+        ariaHidden: string;
+        ariaLabel: any;
+        as: string;
+        bordered: boolean;
+        circular: boolean;
+        color: string;
+        className: any;
+        disabled: boolean;
+        fitted: boolean;
+        flipped: any;
+        inverted: boolean;
+        link: boolean;
+        loading: boolean;
+        rotated: any;
+        size: string;
+        style: any;
+    };
+}
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../ui/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE9C,YAAY,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC"}
+{"mappings":";AAcA,2BACM,GAAG,GACH,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AEbX,4BACM,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;AEpBf,uBACI,aAAa,GACb,QAAQ,GACR,MAAM,GACN,OAAO,GACP,QAAQ,CAAC;ACLb,OAAO,MAAM;;;;;;CAkBZ,CAAC;AACF,OAAO,MAAM;;;;;;;CAoBZ,CAAC;AEvCF,gCAAuC,YAAY,GAAG,cAAc,CAAC;AAErE,gCAAuC,WAAW,GAAG,kBAAkB,CAAC;AMGxE;IACI;;SAEK;IACL,EAAE,EAAE,MAAM,WAAW,CAAC;IAEtB;;SAEK;IACL,QAAQ,EAAE,MAAM,CAAC;IAEjB;;SAEK;IACL,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;SAEK;IACL,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;CAC9B;AAED;;;KAGK;AACL,4BAAqB,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,gBAAgB,eAc5E;kBAdQ,WAAW;;;;;;;;;;;;;;AERpB;IACI;;SAEK;IACL,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;SAEK;IACL,EAAE,CAAC,EAAE,MAAM,WAAW,CAAC;IAEvB;;SAEK;IACL,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;SAEK;IACL,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;SAEK;IACL,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAE7B;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;SAEK;IACL,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;SAEK;IACL,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;SAEK;IACL,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC;;WAEO;IACP,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;SAEK;IACL,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;SAEK;IACL,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;SAEK;IACL,IAAI,EAAE,eAAe,CAAC;IAEtB;;SAEK;IACL,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC;;SAEK;IACL,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAE3B;;SAEK;IACL,KAAK,CAAC,EAAE,MAAM,aAAa,CAAC;CAC/B;AAED,qBAAc,EACV,UAAU,EACV,SAAS,EACT,EAAE,EACF,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,QAAQ,EACR,MAAM,EACN,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,KAAK,EACL,GAAG,KAAK,EACX,EAAE,SAAS,eA0DX;kBA7EQ,IAAI","sources":["ui/ui/core/sizes/sizeTypes.ts","ui/ui/core/sizes/index.ts","ui/ui/core/colors/colorTypes.ts","ui/ui/core/colors/index.ts","ui/ui/core/icons/iconTypes.ts","ui/ui/core/icons/iconTags.ts","ui/ui/core/icons/index.ts","ui/ui/core/miscellaneous-choices/miscellaneousTypes.ts","ui/ui/core/miscellaneous-choices/index.ts","ui/ui/core/index.ts","ui/ui/helpers/getElementTypeFromProps.ts","ui/ui/helpers/classNameBuilders.ts","ui/ui/helpers/index.ts","ui/ui/init/GrauityInit.tsx","ui/ui/init/index.ts","ui/ui/elements/Icon/Icon.tsx","ui/ui/elements/Icon/index.ts","ui/ui/elements/index.ts","ui/ui/index.ts","ui/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,"import './css/index.scss';\n\nexport { ICON_TAGS, TAG_ICONS } from './core';\n\nexport type { GrauityInitProps } from './init';\nexport { GrauityInit } from './init';\n\nexport type { IconProps } from './elements';\nexport { Icon } from './elements';\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@newtonschool/grauity",
-    "version": "0.0.3",
+    "version": "0.0.9",
     "description": "",
     "keywords": [
         "Newton School",
@@ -129,6 +129,8 @@
         "path": "^0.12.7",
         "pre-commit": "^1.2.2",
         "prettier": "2.8.1",
+        "react": "^16.8.0 || ^17.0.0",
+        "react-dom": "^16.8.0 || ^17.0.0",
         "rimraf": "^3.0.2",
         "sass": "^1.57.1",
         "sass-loader": "^13.2.0",
@@ -136,16 +138,14 @@
         "storybook": "^6.5.15",
         "storybook-addon-code-editor": "^0.3.7",
         "style-loader": "^3.3.1",
+        "styled-components": "^5.3.6",
         "svgo": "^3.0.2",
-        "typescript": "^4.9.4",
-        "react": "^16.8.0 || ^17.0.0",
-        "react-dom": "^16.8.0 || ^17.0.0",
-        "styled-components": "^5.3.6"
+        "typescript": "^4.9.4"
     },
     "dependencies": {
         "classnames": "^2.3.2",
-        "prop-types": "^15.8.1",
-        "lodash": "^4.17.21"
+        "lodash": "^4.17.21",
+        "prop-types": "^15.8.1"
     },
     "peerDependencies": {
         "react": "^16.8.0 || ^17.0.0",

package/ui/core/colors/colorTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"colorTypes.d.ts","sourceRoot":"","sources":["colorTypes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACf,SAAS,GACT,WAAW,GACX,UAAU,GACV,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,OAAO,CAAC"}

package/ui/core/colors/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C,eAAO,MAAM,MAAM,UAkBlB,CAAC"}

package/ui/core/icons/iconTags.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"iconTags.d.ts","sourceRoot":"","sources":["iconTags.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;CAMrB,CAAC;AACF,eAAO,MAAM,SAAS;;;;;;;CAOrB,CAAC"}

package/ui/core/icons/iconTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"iconTypes.d.ts","sourceRoot":"","sources":["iconTypes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GACjB,aAAa,GACb,QAAQ,GACR,MAAM,GACN,OAAO,GACP,QAAQ,CAAC;AAEf,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE/E,oBAAY,SAAS;IACjB,UAAU,gBAAgB;IAC1B,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;CACpB"}

package/ui/core/icons/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAElD,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC"}

package/ui/core/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACvD,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC"}