@spaced-out/ui-design-system 0.0.3 → 0.0.4

package/.cspell/custom-words.txt

@@ -2,6 +2,7 @@ atleast
 circlehollow
 commitlint
 contributorsrc
+Crespo
 DEFAULTTEXT
 dismissable
 Fennimore
@@ -18,6 +19,7 @@ preminor
 prepatch
 rgba
 sbdocs
+Stapleton
 superrover
 testid
 tnum

package/.eslintignore

@@ -1 +1,2 @@
-/src/assets/fontawesome/
+/src/assets/fontawesome/
+node_modules/

package/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+### Description of changes
+<!--- Describe your changes in detail -->
+
+### Design Specs(Add a link to Spec sheet)
+<!--- Add a link to design specs -->
+
+### Screenshots(if appropriate)
+
+### Does this close any currently open issues?
+
+### Breaking changes(Describe if any)
+
+### Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] Merged with latest `master` branch
+- [ ] I have updated the documentation accordingly.

package/.prettierrc

@@ -1,11 +1,27 @@
-trailingComma: 'all'
-bracketSpacing: false
-singleQuote: true
-endOfLine: lf
-overrides:
-  - files: ['*.js', '*.jsx']
-    options:
-      parser: 'babel-flow'
-  - files: ['*.css']
-    options:
-      parser: 'css'
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "bracketSpacing": false,
+  "endOfLine": "lf",
+  "overrides": [
+    {
+      "files": [
+        "*.js",
+        "*.jsx"
+      ],
+      "options": {
+        "parser": "babel-flow"
+      }
+    },
+    {
+      "files": [
+        "*.css"
+      ],
+      "options": {
+        "parser": "css"
+      }
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "eslint.validate": ["javascript", "javascriptreact"],
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "marquee.widgets.npm-stats.packageNames": ["@spaced-out/ui-design-system"]
+}

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 0.0.4 (2022-11-24)
+
+
+### Features
+
+* pr template ([#35](https://github.com/Spaced-Out/ui-design-system/issues/35)) ([c18e112](https://github.com/Spaced-Out/ui-design-system/commit/c18e1123730acaad77e1334a949573ac0cfd3708))
+
 ### 0.0.3 (2022-11-22)
 
 

package/CONTRIBUTING.md

@@ -144,9 +144,9 @@ Most commonly used commit prefixes:
 
 > `build:` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, etc.
 
-## Add yourself to the contributor list
+## Add yourself to the maintainer list
 
-To add yourself to the `all-contributors` table in the README and INTRODUCTION stories:
+To add yourself to the `maintainers` table in the README and INTRODUCTION stories:
 
 > Run the following commands from the root of the repo:
 

package/README.md

@@ -101,6 +101,10 @@ import * as SIZES from "@spaced-out/ui-design-system/lib/styles/variables/_size.
 
 Check out our [**Contribution Guide**](https://spaced-out.github.io/ui-design-system/?path=/docs/contribution--page) to setup and contribute to Genesis.
 
+## Changelog
+
+Check out our [**Changelog here**](https://spaced-out.github.io/ui-design-system/?path=/docs/changelog--page)
+
 ## Maintainers ✨
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

package/lib/components/Tooltip/Tooltip.js

@@ -22,7 +22,9 @@ const Tooltip = _ref => {
     children,
     title,
     body,
-    placement = 'top'
+    placement = 'top',
+    bodyMaxLines = 2,
+    titleMaxLines = 1
   } = _ref;
   const [open, setOpen] = React.useState(false);
   const {
@@ -53,7 +55,7 @@ const Tooltip = _ref => {
     ...children.props
   })), open && /*#__PURE__*/React.createElement("div", _extends({
     ref: floating,
-    className: (0, _classify.classify)(_TooltipModule.default.tooltip, classNames?.wrapper),
+    className: (0, _classify.classify)(_TooltipModule.default.tooltip, classNames?.tooltip),
     style: {
       position: strategy,
       top: y ?? _space.spaceNone,
@@ -62,11 +64,11 @@ const Tooltip = _ref => {
   }, getFloatingProps()), !!title && /*#__PURE__*/React.createElement(_Text.SubTitleExtraSmall, {
     color: "inversePrimary"
   }, /*#__PURE__*/React.createElement(_Truncate.Truncate, {
-    line: 1
+    line: titleMaxLines
   }, title)), !!body && /*#__PURE__*/React.createElement(_Text.BodyMedium, {
     color: !title ? 'inversePrimary' : 'inverseSecondary'
   }, /*#__PURE__*/React.createElement(_Truncate.Truncate, {
-    line: 2
+    line: bodyMaxLines
   }, body))));
 };
 exports.Tooltip = Tooltip;

package/lib/components/Tooltip/Tooltip.js.flow

@@ -33,13 +33,23 @@ import {Truncate} from '../Truncate';
 import css from './Tooltip.module.css';
 
 
-type ClassNames = $ReadOnly<{wrapper?: string}>;
+type ClassNames = $ReadOnly<{tooltip?: string}>;
 
 export type TooltipProps = {
   classNames?: ClassNames,
-  title?: string,
-  body?: string,
-  placement?: 'top' | 'bottom' | 'left' | 'right',
+  title?: string | React.Node,
+  body?: string | React.Node,
+  placement?:
+    | 'top'
+    | 'top-start'
+    | 'top-end'
+    | 'bottom'
+    | 'bottom-start'
+    | 'bottom-end'
+    | 'left'
+    | 'right',
+  bodyMaxLines?: number,
+  titleMaxLines?: number,
   // TODO(Nishant): Decide on a type to use
   // $FlowFixMe
   children: any,
@@ -51,6 +61,8 @@ export const Tooltip = ({
   title,
   body,
   placement = 'top',
+  bodyMaxLines = 2,
+  titleMaxLines = 1,
 }: TooltipProps): React.Node => {
   const [open, setOpen] = React.useState(false);
 
@@ -79,12 +91,15 @@ export const Tooltip = ({
     <>
       {React.cloneElement(
         children,
-        getReferenceProps({ref, ...children.props}),
+        getReferenceProps({
+          ref,
+          ...children.props,
+        }),
       )}
       {open && (
         <div
           ref={floating}
-          className={classify(css.tooltip, classNames?.wrapper)}
+          className={classify(css.tooltip, classNames?.tooltip)}
           style={{
             position: strategy,
             top: y ?? spaceNone,
@@ -94,13 +109,13 @@ export const Tooltip = ({
         >
           {!!title && (
             <SubTitleExtraSmall color="inversePrimary">
-              <Truncate line={1}>{title}</Truncate>
+              <Truncate line={titleMaxLines}>{title}</Truncate>
             </SubTitleExtraSmall>
           )}
 
           {!!body && (
             <BodyMedium color={!title ? 'inversePrimary' : 'inverseSecondary'}>
-              <Truncate line={2}>{body}</Truncate>
+              <Truncate line={bodyMaxLines}>{body}</Truncate>
             </BodyMedium>
           )}
         </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spaced-out/ui-design-system",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "main": "index.js",
   "description": "Sense UI components library",
   "author": {
@@ -32,9 +32,10 @@
     "React",
     "Component",
     "Library",
-    "Rollup",
-    "Sass",
-    "Storybook"
+    "Design System",
+    "Genesis",
+    "Spaced Out",
+    "Sense"
   ],
   "peerDependencies": {
     "react": ">=16.8.0",

package/pull_request_template.md

@@ -1,48 +0,0 @@
-* **Please check if the PR fulfills these requirements**
-- [ ] The commit message follows our guidelines
-- [ ] Tests for the changes have been added (for bug fixes / features)
-- [ ] Docs have been added / updated (for bug fixes / features)
-
-
-* **Other information**:
-
-### All Submissions:
-
-* [ ] Have you followed the guidelines in our Contributing document?
-* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
-
-<!-- You can erase any parts of this template not applicable to your Pull Request. -->
-
-
-## Types of changes
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
-
-<!--- Provide a general summary of your changes in the Title above -->
-
-## Description
-<!--- Describe your changes in detail -->
-
-## Design Specs
-<!--- Add a link to design specs -->
-
-## Motivation and Context
-<!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
-
-## How has this been tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, tests ran to see how -->
-<!--- your change affects other areas of the code, etc. -->
-
-## Screenshots (if appropriate):
-
-
-## Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] My code follows the code style of this project.
-- [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.