feat: add functions

Author: maxgfr

.releaserc.json

@@ -10,6 +10,7 @@
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
     "@semantic-release/npm",
     "@semantic-release/github",
     "@semantic-release/git"

README.md

@@ -1,32 +1,13 @@
-# typescript-react-lib-swc
+# react-essentials-functions
 
-A simple react boilerplate for creating a library of components made in typescript using `swc`.
+A collection of useful `hooks` and `components` for React that I use in my projects.
 
-It also uses:
-- `storybook` for viewing a components
-- `testing-library` for testing components
-- `semantic-release` for publishing a package for this library components
+## Installation
 
-## Clone repository and install dependencies
-
-```sh
-git clone https://github.com/maxgfr/typescript-react-lib-swc # For cloning the repository
-cd typescript-react-lib-swc # To navigate to the repository root
-yarn # Install dependencies
-```
-
-## Building the code
-
-```sh
-yarn build # For building the code with typechecking
-yarn build:swc # For building without typechecking
+```bash
+yarn add react-essentials-functions
 ```
 
-> **:warning: No typechecking made in dev mode**
-
-## Testing the code
+## Usage
 
-```sh
-yarn test # For running unit test
-yarn test:watch # For watching unit test
-```
+Documentation is in progress...

package.json

@@ -1,28 +1,26 @@
 {
-  "name": "typescript-react-lib-swc",
-  "version": "1.0.1",
+  "name": "react-essentials-functions",
+  "version": "1.0.0",
   "author": "maxgfr",
   "license": "MIT",
-  "description": "A minimalist typescript swc starter for react",
+  "description": "A collection of zero-dependencies useful hooks and components for React",
   "main": "./build/index.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/maxgfr/typescript-react-lib-swc.git"
+    "url": "https://github.com/maxgfr/react-essentials-functions.git"
   },
   "bugs": {
-    "url": "https://github.com/maxgfr/typescript-react-lib-swc/issues"
+    "url": "https://github.com/maxgfr/react-essentials-functions/issues"
   },
-  "homepage": "https://github.com/maxgfr/typescript-react-lib-swc#readme",
+  "homepage": "https://github.com/maxgfr/react-essentials-functions#readme",
   "files": [
     "build"
   ],
   "keywords": [
-    "boilerplate",
-    "typescript",
-    "swc",
+    "hooks",
     "react",
-    "storybook",
-    "@testing-library"
+    "components",
+    "useful"
   ],
   "scripts": {
     "dev": "nodemon",
@@ -42,12 +40,13 @@
     "storybook:deploy:action": "npm run storybook:build && gh-pages -d storybook-static -u \"github-actions-bot <support+actions@github.com>\"",
     "release": "semantic-release"
   },
-  "dependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
   },
   "devDependencies": {
     "@babel/core": "^7.20.2",
+    "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^8.0.6",

src/HelloWorld.tsx

@@ -0,0 +1,20 @@
+import * as React from 'react';
+
+export type ConditionnalWrapperProps = {
+  condition: boolean;
+  wrapper: (children: React.ReactNode) => React.ReactNode;
+  children: React.ReactNode;
+};
+
+export const ConditionalWrapper = ({
+  condition,
+  wrapper,
+  children,
+}: ConditionnalWrapperProps) => (condition ? wrapper(children) : children);
+
+// <ConditionalWrapper
+//      condition={link}
+//      wrapper={children => <a href={link}>{children}</a>}
+//    >
+//     .....
+//    </ConditionalWrapper>

src/Input.tsx

@@ -0,0 +1 @@
+export * from './ConditionnalWrapper';

src/__tests__/HelloWorld.test.tsx

@@ -0,0 +1,6 @@
+export * from './useDimensions';
+export * from './useSafeFetch';
+export * from './useSafeState';
+export * from './useScript';
+export * from './useTheme';
+export * from './useWindowDimensions';