@geposit/valid-ui v0.1.2

Component library that will allow you to integrate VALID™ with your React application with ease in couple minutes and benefit some of its features.

Installation

Valid UI is available as an npm package.

npm:

npm install @geposit/valid-ui

yarn:

yarn add @geposit/valid-ui

What is VALID™

Valid™ is a service for Nordic address control that is always updated with the latest address data.

The service checks the validity of addresses, and also helps the user to fill in the address using autocomplete suggestions for addresses. This way, the user-friendliness and thus also the probability of conversion to a purchase increases.

You never have to worry about incorrect addresses again!

If you need more information about valid see our Valid Documentation

VALID™ UI

It's an extension package that exposes multiple components built on top of VALID™ API. These components allow you to integrate VALID™ Autocomplete functionality in couple minutes, where you just import a component and start using it.

As simple as that:

import { ValidSuggestion, Search } from '@geposit/valid-search';

<Search country="se" onSelect={(option: ValidSuggestion) => console.log(option)} validKey={YOUR_VALID_KEY} />

Library also contains multiple components and utils that will help you to integrate. You can find an interactive component documentation with examples in our Storybook

Issues

If you find any issues with this package please report it in our Github issues page

Development

Package is using yarn 1.x so make sure you have it installed before starting to work with it. After you check out the repository run yarn of yarn install to get the required dependencies.

Developing package

To start developing and testing features you will need to start them in storybook or link package to your project.

To run Storybook in development mode

yarn storybook

Building package

To build a package you will simply run

yarn build

This will create a dist folder with package prepared to be used in any project.

Building storybook

To build storybook you will need to run

yarn build-storybook

This will generate storybook-static folder with storybook's static files that are ready to be hosted on any web hosting.

What will be added next?

In the near feature we will be preparing a styling functionality, where you can overwrite our default styling with ease. Someday we will expose more components and utils that will increase possibilities of integration with VALID™.