@c4i/errorhandler
v1.0.4
Published
React component which can manage the layers displayed in an react-webmapjs component.
Downloads
14
Readme
C4I ErrorHandler
The C4I ErrorHandler is an errorhandler written in Redux for the Climate4Impact portal.
It gives access to a number of actions that you can call from your own React
or Redux
application, regarding adding and deleting error messages.
The errorhandler also enables you to display these error messages on your application by using ReactStrap
.
DISCLAIMER: Versions before 1.0.0
are unstable and not recommended for use.
Dependencies
Make sure you have the following packages installed:
- React
- Redux
- React-Redux
Installation
Open the terminal and enter npm install @c4i/errorhandler
.
Summary
errorHandlerAdd
adds an error to the list. You need to call it with the necessary parameters (message
anderror
).errorHandlerDismiss
dismisses an error from the list. You need to call it with the necessary parameter (id
).errorHandlerDismissAll
dissmises all the errors from the list. You need to call it without any parameters.
Usage
- Import Error and errorHandlerAdd:
import { ErrorWrapper, errorHandlerAdd } from '@c4i/errorhandler'
. - Add
<ErrorWrapper />
where error messages need to be rendered. - Add a dispatch function that calls
errorHandlerAdd
with the necessary parameters (message
anderror
). - To create an error message, call the dispatch function with a message and error/exception (
this.errorHandlerAdd('Test message', exception)
).
Publishing
- Write unit tests ;)
- Adjust version number in package.json
- Commit your code
npm run build
npm publish
License
Copyright 2019 KNMI
Licensed under the Apache License
, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.