@semcore/feedback-form 5.1.1 → 5.1.2

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 CHANGELOG.md standards are inspired by [keepachangelog.com](https://keepachangelog.com/en/1.0.0/).
 
+## [5.1.2] - 2022-07-07
+
+### Changed
+
+- Version patch update due to children dependencies update (`@semcore/button` [4.0.6 ~> 4.0.7], `@semcore/utils` [3.33.0 ~> 3.34.0]).
+
 ## [5.1.1] - 2022-06-28
 
 ### Fixed

package/README.md

@@ -1,82 +1,67 @@
-```js
-import React from 'react';
-import Link from '@semcore/link';
-import Input from '@semcore/input';
-import Textarea from '@semcore/textarea';
-import Checkbox from '@semcore/checkbox';
-import Chat from '@semcore/icon/Chat/m';
-import Dropdown from '@semcore/dropdown';
+# @semcore/feedback-form
+
+[![version](https://img.shields.io/npm/v/@semcore/feedback-form.svg)](https://www.npmjs.com/@semcore/feedback-form)
+[![downloads](https://img.shields.io/npm/dt/@semcore/feedback-form.svg)](https://www.npmjs.com/package/@semcore/feedback-form)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/semrush/intergalactic/blob/master/LICENSE)
+
+> This component is part of the Intergalactic design system
+
+### 📖 [Component documentation](https://developer.semrush.com/intergalactic/components/feedback-form/)
+
+### 🏠 [Design system](https://developer.semrush.com/intergalactic/)
+
+## Install
+
+```sh
+npm install @semcore/ui
+```
+
+## Usage
+
+```jsx
+import FeedbackForm from '@semcore/ui/feedback-form';
+```
+
+<details>
+  <summary>Alternative installation and use</summary>
+
+**We do not recommend this usage path due to possible dependency and update issues.**
+
+### Install
+
+You can only install one package from the design system
+
+```sh
+npm install @semcore/feedback-form @semcore/core
+```
+
+`@semcore/core` - _is the basic package by which we create our components, and it contains all of the common logic
+of the components that is discussed below. There should only be one version of the package in the project._
+
+### Usage
+
+You can use the package the same way but without `/ui/` in the import path.
+
+ </details>
+
+```jsx
 import FeedbackForm from '@semcore/feedback-form';
-import { Box } from '@semcore/flex-box';
-import { Small } from '@semcore/typography';
-
-import If from '@semcore/utils/lib/if';
-
-class MyFeedback extends React.PureComponent {
-  render() {
-    const validateDescription = FeedbackForm.validate.description(
-      `Your feedback must contain at least 3 words (10 characters).`,
-    );
-    const validateEmail = FeedbackForm.validate.email(`Please enter valid email.`);
-
-    return (
-      <Dropdown>
-        <Dropdown.Trigger>
-          <Link before={<Chat />}>Send feedback</Link>
-        </Dropdown.Trigger>
-        <Dropdown.Popper>
-          {({ changeVisible }) => (
-            <FeedbackForm onSubmit={(data) => console.log(data)}>
-              {({ submitSucceeded }) => (
-                <React.Fragment>
-                  <If condition={submitSucceeded}>
-                    <FeedbackForm.Success>Thank you for your feedback!</FeedbackForm.Success>
-                  </If>
-                  <If condition={!submitSucceeded}>
-                    <FeedbackForm.Item
-                      name="feedback"
-                      tag={Textarea}
-                      validate={validateDescription}
-                      fullWidth
-                      autoFocus
-                      placeholder="Please tell us your suggestion or report an issue"
-                    />
-                    <FeedbackForm.Item
-                      name="email"
-                      tag={Input}
-                      type="email"
-                      validate={validateEmail}
-                      placeholder="Reply-to email"
-                    />
-                    <Box mt={-2} mb={4} mx={4}>
-                      <Small>
-                        We will only use this email to respond to you on your feedback.{' '}
-                        <Link href="#">Privacy Policy</Link>
-                      </Small>
-                    </Box>
-                    <FeedbackForm.Item name="needHelp" type="checkbox">
-                      {({ input }) => (
-                        <Checkbox {...input} size="s">
-                          I need help, please contact me
-                        </Checkbox>
-                      )}
-                    </FeedbackForm.Item>
-                    <Box m={4}>
-                      <FeedbackForm.Submit>Send feedback</FeedbackForm.Submit>
-                      <FeedbackForm.Cancel onClick={() => changeVisible(false)}>
-                        Cancel
-                      </FeedbackForm.Cancel>
-                    </Box>
-                  </If>
-                </React.Fragment>
-              )}
-            </FeedbackForm>
-          )}
-        </Dropdown.Popper>
-      </Dropdown>
-    );
-  }
-}
-
-export default MyFeedback;
 ```
+
+## 👤 Author
+
+[UI-kit team](https://github.com/semrush/intergalactic/blob/master/MAINTAINERS) and [others ❤️](https://github.com/semrush/intergalactic/graphs/contributors)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!
+
+Feel free to check [issues page](https://github.com/semrush/intergalactic/issues). You can also take a look at the [contributing guide](https://github.com/semrush/intergalactic/blob/master/CONTRIBUTING.md).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+This project is [MIT](https://github.com/semrush/intergalactic/blob/master/LICENSE) licensed.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@semcore/feedback-form",
   "description": "SEMRush Feedback Form Component",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "main": "lib/cjs/index.js",
   "module": "lib/es6/index.js",
   "typings": "lib/types/index.d.ts",
   "sideEffects": false,
-  "author": "Roman Lysov <r.lysov@semrush.com>",
+  "author": "UI-kit team <ui-kit-team@semrush.com>",
   "license": "MIT",
   "scripts": {
     "build": "build --source=js",