So erstellen Sie einen benutzerdefinierten Reaktions-Hook und veröffentlichen ihn in npm

Hooks sind eine praktische Ergänzung zur React-API, mit der wir einen Teil unserer Logik und unseres Status in Funktionskomponenten organisieren können. Wie können wir einen benutzerdefinierten Haken erstellen und ihn mit dem Rest der Welt teilen?

  • Was sind Haken?
  • Warum sind benutzerdefinierte Haken cool?
  • Was machen wir?
  • Schritt 0: Benennen Sie Ihren Haken
  • Schritt 1: Einrichten Ihres Projekts
  • Schritt 2: Schreiben Sie Ihren neuen React Hook
  • Schritt 3: Verwenden Sie Ihren React-Hook in einem Beispiel
  • Schritt 4: Kompilieren Sie Ihren React-Hook und Ihr Beispiel
  • Schritt 5: Veröffentlichen Sie Ihren React-Hook auf npm
  • Weitere Ressourcen zu Hooks

Was sind Haken?

Reaktionshaken in einfachen Worten sind Funktionen. Wenn Sie sie in Ihre Komponente oder in einen anderen Hook aufnehmen, können Sie damit React-Interna und Teile des React-Lebenszyklus mit nativen Hooks wie useStateund verwenden useEffect.

Ich habe nicht vor, mich intensiv mit Hooks zu beschäftigen, aber Sie können sich eine kurze Einführung mit einem Beispiel useStatesowie dem Intro des React-Teams ansehen.

Warum sind benutzerdefinierte Haken cool?

Das Tolle an der Erstellung benutzerdefinierter Hooks ist, dass Sie damit die Logik für Ihre Komponenten abstrahieren können, um die Wiederverwendung über mehrere Komponenten in Ihrer App hinweg zu vereinfachen.

Wenn Sie beispielsweise einen einfachen Zähler erstellen möchten, bei dem Sie den Status von React verwenden, um die aktuelle Anzahl zu verwalten. Anstatt useStatein jeder Komponentendatei denselben Hook zu haben, können Sie diese Logik einmal in einem useCounterHook erstellen, um das Verwalten , Erweitern und Beseitigen von Fehlern zu vereinfachen, wenn sie auftreten.

Was machen wir?

Für die Zwecke dieses Artikels werden wir es mit einem einfachen Haken einfach halten. In der Regel verwenden Sie möglicherweise einen Hook, da Sie anstelle einer typischen Funktion andere native Hooks verwenden, die in den React-Funktionskomponenten verwendet werden müssen. Wir werden uns an einige grundlegende Ein- und Ausgaben halten, um die Dinge einfach zu halten.

Wir werden diesen benutzerdefinierten Placecage-Hook, den ich erstellt habe, neu erstellen, mit dem Sie auf einfache Weise Bild-URLs generieren können, die Sie als Platzhalterbilder verwenden können.

Wenn Sie nicht vertraut sind, ist Placecage eine API, mit der Sie Bilder von Nic Cage als Platzhalterbilder für Ihre Website erstellen können. Dumm? Ja. Spaß? Absolut!

Aber wenn Sie kein Fan von Nic's Arbeit sind, können Sie genauso einfach die URL für Fill Murray austauschen, die Bilder von Bill Murray verwendet, oder placeholder.com, das einen einfachen einfarbigen Hintergrund mit Text erzeugt, der die Größe des Bildes anzeigt.

Schritt 0: Benennen Sie Ihren Haken

Bevor wir zu unserem eigentlichen Code springen, ist es unser oberstes Ziel, diesen Hook zu veröffentlichen. Wenn dies nicht Ihr Ziel ist, können Sie diesen Schritt überspringen. Für die Veröffentlichung möchten wir jedoch einen Namen für unseren Hook erstellen.

In unserem Fall lautet unser Hakenname usePlaceCage. In diesem Sinne haben wir zwei Formate unseres Namens - eines im CamelCase-Format und eines im Snake-Case-Format.

  • camelCase: usePlaceCage
  • Schlangenfall: Use-Placecage

Das camelCase-Format wird für die eigentliche Hook-Funktion verwendet, wobei der Name des Schlangenfalls für den Paketnamen und einige der Ordner verwendet wird. Beachten Sie beim Erstellen des Namens, dass der Paketname eindeutig sein muss. Wenn auf npmjs.com bereits ein gleichnamiges Paket vorhanden ist, können Sie es nicht verwenden.

Wenn Sie noch keinen Namen haben, ist es okay! Sie können einfach Ihren eigenen Namen oder etwas verwenden, an das Sie denken können. Es ist nicht wirklich wichtig, da wir wirklich nur versuchen zu lernen, wie das geht. Wenn ich es zum Beispiel wäre, würde ich verwenden:

  • camelCase: useColbysCoolHook
  • Schlangenfall: use-colbyscoolhook

Aber nur um zu verdeutlichen, bleiben wir für den Rest unseres Beispiels bei usePlaceCageund use-placecage.

Schritt 1: Einrichten Ihres Projekts

Obwohl Sie Ihr Projekt nach Belieben einrichten können, werden wir anhand dieser von mir erstellten Vorlage einen neuen Hook erstellen.

Die Hoffnung hier ist, dass wir einige der schmerzhaften Teile des Prozesses herausnehmen und sofort mit unserem benutzerdefinierten Haken produktiv werden können. Mach dir keine Sorgen, ich werde erklären, was auf dem Weg los ist.

Die Anforderungen hier sind Git und Garn, da es Tools bereitstellt, mit denen diese Vorlage einfach erstellt werden kann, z. B. die Verwendung der Arbeitsbereichsfunktion, mit der einfache npm-Skripte den Code vom Stammverzeichnis des Projekts aus verwalten können. Wenn einer von beiden ein Dealbreaker ist, können Sie versuchen, das Repo über den Download-Link herunterzuladen und bei Bedarf zu aktualisieren.

Klonen der Hook-Vorlage von Git

Lassen Sie uns zunächst das Repository von Github klonen. Im folgenden Befehl sollten Sie durch use-my-custom-hookden Namen Ihres Hooks ersetzen , z. B. use-cookiesoder use-mooncake.

git clone //github.com/colbyfayock/use-custom-hook use-my-custom-hook cd use-my-custom-hook 

Sobald Sie geklont und zu diesem Ordner navigiert haben, sollten jetzt zwei Verzeichnisse angezeigt werden - ein exampleVerzeichnis und ein use-custom-hookVerzeichnis.

Dies gibt Ihnen ein paar Dinge, um loszulegen:

  • Ein Hook-Verzeichnis, das die Quelle für unseren Hook enthält
  • Erstellen Sie Skripte, die unseren Hook mit babel kompilieren
  • Eine Beispielseite, die unseren Hook importiert und mit next.js eine einfache Demoseite erstellt

Ausführen der Hook-Setup-Skripte

Nachdem wir das Repo erfolgreich geklont haben, möchten wir die Setup-Skripte ausführen, die Abhängigkeiten installieren, und den Hook auf den gewünschten Namen aktualisieren.

yarn install && yarn setup 

Wenn das Setup-Skript ausgeführt wird, werden einige Dinge ausgeführt:

  • It will ask you for your name – this is used to update the LICENSE and the package's author name
  • It will ask you for your hook's name in 2 variations – camelCase and snake-case - this will be used to update the name of the hook throughout the template and move files with that name to the correct location
  • It will reset git – it will first remove the local .git folder, which contains the history from my template and reinitialize git with a fresh commit to start your new history in
  • Finally, it will remove the setup script directory and remove the package dependencies that were only being used by those scripts

Starting the development server

Once the setup scripts finish running, you'll want to run:

yarn develop 

This runs a watch process on the hook source, building the hook locally each time a source file is changed, and running the example app server, where you can test the hook and make changes to the example pages.

With this all ready, we can get started!

Follow along with the commit!

Step 2: Writing your new React Hook

At this point, you should now have a new custom hook where you can make it do whatever you'd like. But since we're going to walk through rebuilding the usePlaceCage hook, let's start there.

The usePlaceCage hook does 1 simple thing from a high level view – it takes in a configuration object and returns a number of image URLs that you can then use for your app.

Just as a reminder, any time I mention usePlaceCage or use-placecage, you should use the hook name that you set up before.

A little bit about placecage.com

Placecage.com is a placeholder image service that does 1 thing. It takes a URL with a simple configuration and returns an image... of Nic Cage.

From the simplest use, the service uses a URL pattern as follows:

//www.placecage.com/200/300 

This would return an image with a width of 200 and height of 300.

Optionally, you can pass an additional URL parameter that defines the type of image:

//www.placecage.com/gif/200/300 

In this particular instance, our type is gif, so we'll receive a gif.

The different types available to use are:

  • Nothing: calm
  • g: gray
  • c: crazy
  • gif: gif

We'll use this to define how we set up configuration for our hook.

Defining our core generator function

To get started, we're going to copy over a function at the bottom of our use-placecage/src/usePlaceCage.js file, which allows us to generate an image URL, as well as a few constant definitions that we'll use in that function.

First, let's copy over our constants to the top of our usePlaceCage.js file:

const PLACECAGE_HOST = '//www.placecage.com/'; const TYPES = { calm: null, gray: 'g', crazy: 'c', gif: 'gif' }; const DEFAULT_TYPE = 'calm'; const ERROR_BASE = 'Failed to place Nick'; 

Here we:

  • Define a host, which is the base URL of our image service.
  • Define the available types, which we'll use in the configuration API. We set calm to null, because it's the default value which you get by not including it at all
  • Our default type will be calm
  • And we set an error base which is a consistent message when throwing an error

Then for our function, let's copy this at the bottom of our usePlaceCage.js file:

function generateCage(settings) { const { type = DEFAULT_TYPE, width = 200, height = 200, count = 1 } = settings; const config = []; if ( type !== DEFAULT_TYPE && TYPES[type] ) { config.push(TYPES[type]); } config.push(width, height); if ( isNaN(count) ) { throw new Error(`${ERROR_BASE}: Invalid count ${count}`); } return [...new Array(count)].map(() => `${PLACECAGE_HOST}${config.join('/')}`); } 

Walking through this code:

  • We define a generateCage function which we'll use to generate our image URL
  • We take in a settings object as an argument, which defines the configuration of our image URL. We'll be using the same parameters as we saw in our placecage.com URL
  • We destructure those settings to make them available for us to use
  • We have a few defaults here just to make it easier. Our default type will be defined by DEFAULT_TYPE along with a default width, height, and number of results we want to return
  • We create a config array. We'll use this  to append all of the different configuration objects in our URL and finally join them together with a / essentially making a URL
  • Before we push our config to that array, we check if it's a valid argument, by using the TYPES object to check against it. If it's valid, we push it to our config array
  • We then push our width and height
  • We do some type checking, if we don't have a valid number as the count, we throw an error, otherwise we'll get incorrect results
  • Finally, we return a new array with the number of results requested, mapped to a URL creator, which uses PLACECAGE_HOST as our defined base URL, and with our config array joined by /

And if we were to test this function, it would look like this:

const cage = generateCage({ type: 'gif', width: 500, height: 500, count: 2 }); console.log(cage); // ['//www.placecage.com/gif/500/500', '//www.placecage.com/gif/500/500']

Using our function in the hook

So now that we have our generator function, let's actually use it in our hook!

Inside of the usePlaceCage function in the use-placecage/src/usePlaceCage.js file, we can add:

export default function usePlaceCage (settings = {}) { return generateCage(settings); } 

What this does it uses our generator function, takes in the settings that were passed into the hook, and returns that value from the hook.

Similar to our previous use example, if we were to use our hook, it would look like this:

const cage = usePlaceCage({ type: 'gif', width: 500, height: 500, count: 2 }); console.log(cage); // ['//www.placecage.com/gif/500/500', '//www.placecage.com/gif/500/500'] 

At this point, it does the same thing!

So now we have our hook, it serves as a function to generate image URLs for the placecage.com service. How can we actually use it?

Follow along with the commit!

Step 3: Using your React hook in an example

The good news about our template, is it already includes an example app that we can update to easily make use of our hook to both test and provide documentation for those who want to use it.

Setting up the hook

To get started, let's open up our example/pages/index.js file. Inside of this file you'll see the following:

const hookSettings = { message: 'Hello, custom hook!' } const { message } = usePlaceCage(hookSettings); 

This snippet is what was used by default in the template just for a proof of concept, so let's update that. We're going to use the same exact configuration as we did in Step 2:

const hookSettings = { type: 'gif', width: 500, height: 500, count: 2 } const cage = usePlaceCage(hookSettings); 

Again, we set up our settings object with the configuration for our hook and invoke our hook and set the value to the cage constant.

If we now console log that value our to our dev tools, we can see it working!

console.log('cage', cage); 

Note: If you get an error here about message, you  can comment that our or remove it under the Examples section.

Updating the example with our new hook configuration

If you scroll down to the Examples section, you'll notice that we have the same default hookSettings as above, so let's update that again to make sure our example is accurate.

{`const hookSettings = { type: 'gif', width: 500, height: 500, count: 2 } const cage = usePlaceCage(hookSettings);`} 

You'll also notice that we're no longer using the message variable. If you didn't remove it in the last step, we can now replace it under the Output heading with:

{ JSON.stringify(cage) }

{ cage.map((img, i) =>)}

We're doing 2 things here:

  • Instead of showing the variable itself, we wrap it with JSON.stringify so that we can show the contents of the array
  • We also use the map function to loop over our image URLs in the cage constant and create a new image element for each. This let's us preview the output instead of just seeing the values

And once you save and open your browser, you should now see your updated examples and output!

Other things you can do on that page

Before moving on, you can also update a few other things that will be important for your hooks page:

  • Update the How to use section with instructions
  • Add additional examples to make it easier for people to know what to do

A  few things are also automatically pulled in from the use-placecage/package.json file. You can either update them there to make it easier to maintain or you can replace them in the example page:

  • name: Is used at the

    of the page

  • description: Is used at the description under the

  • repository.url: Used to include a link to the repository
  • author: The name and url are used to include a link at the bottom of the page

Follow along with the commit!

Step 4: Compiling your React hook and Example

The way we can make our hook work easily as an npm module is to compile it for others to use. We're using babel to do this.

Though the publish process already does this for us automatically with the prepublishOnly script in use-placecage/package.json, we can manually compile our hook using the yarn build command from the root of the project.

Along with compiling the hook, running yarn build will also compile the example page, allowing you to upload it wherever you'd like. After running that command, you should see an output of static HTML files in the example/out directory.

If you're looking for a recommendation, Netlify makes it easy to connect your Github account and deploy the static site.

See the demo site deployed to Netlify!

Step 5: Publishing your React hook to npm

Finally, if you're happy with your hook, it's time to publish!

npm makes this part really easy. The only prerequisite you need to have an npm account. With that account, let's log in:

npm login 

Which will prompt you for your login credentials.

Next, let's navigate to our hook's directory, as our package configuration is there under use-placecage/package.json:

cd use-placecage 

Then, we can simply publish!

npm publish 

Keep in mind, that each package name needs to be unique. If you used use-placecage, it's already taken... by me. ?

But if you're successful, npm should build your hook and upload it to the package registry!

It will then be available on npm with the following pattern:

//www.npmjs.com/package/[package-name] 

So for use-placeage, it's available here: //www.npmjs.com/package/use-placecage

We now have a custom hook!

Yay ? if you followed along, you should now have created a custom hook and published it to npm.

Though this was a silly example using placecage.com, it gives us a good idea of how we can easily set this up.

You'll also notice that this specific example wasn't the best use case for a hooks, where we could have simply used a function. Typically, we'll want to use custom hooks to wrap functionality that can only live inside a React component, such as useState. To learn more about that, you can read one of my other articles about custom hooks.

However, this gave us a good basis to talk through the creation and configuration of our new hook!

More resources about hooks

  • How to destructure the fundamentals of React Hooks (freecodecamp.org)
  • Introducing Hooks (reactjs.org)
  • Hooks API Reference (reactjs.org)

Follow me for more Javascript, UX, and other interesting things!

  • ? Follow Me On Twitter
  • ?️ Subscribe To My Youtube
  • ✉️ Sign Up For My Newsletter