Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.05 KB

README.md

File metadata and controls

90 lines (66 loc) · 2.05 KB

@hxh-core/react

@hxh-core/react fully supports TypeScript.

RU documentation

Installation

Install the library with npm

npm install @hxh-core/react

or with yarn

yarn add @hxh-core/react

Usage

Helpers

setUrlBeforeImageName prepends the URL to the photo name. It can also be used with regular strings.

setUrlBeforeImageName('image1.jpg', 'https://example.com/');
// Returns https://example.com/image1.jpg
// OR
const images = ['image1.jpg', 'image2.jpg'];
setUrlBeforeImageName(images, 'https://example.com/');
// Returns ['https://example.com/image1.jpg', 'https://example.com/image2.jpg']

getNeedStyle returns styles as styles.active

getNeedStyle({
	isActive: true, // or your condition
	styles: styles, // module styles
	needStyle: styles.active,
});
// If needStyle is not passed, then by default returns styles.active

closeModalOnPress is used to close modal windows when pressing a button on the keyboard

import { getNeedStyle, closeModalOnPress } from '@hxh-core/react/dist/helpers';
import styles from './TestComponent.module.css';

export const TestComponent = () => {
	const [isOpenModal, setIsOpenModal] = useState(false);

	return (
		<div
			className={`${getNeedStyle({
				isActive: isOpenModal,
				styles,
				needStyle: styles.open,
			})}`}
			onKeyDown={(event) =>
				closeModalOnPress({
					event,
					key = 'Escape', // Default
					setIsOpen: setIsOpenModal,
					overflowClass: 'body-overflow', // If you add a class to body that adds overflow: hidden
				})
			}
		>
			{/* ...modal code */}
		</div>
	);
};

Contribution to the project

We welcome any contributions to our project! Please read the deposit guidelines before you begin.

License

HxH is MIT Licensed.

Contacts

VK Group: HxH Marketing

TG Creator: Kireev Dev