@watermarkinsights/ripple-react
Advanced tools
Comparing version 3.0.0-0 to 3.0.0-1
/// <reference types="react" /> | ||
import type { JSX } from 'wm-components'; | ||
import type { JSX } from '@watermarkinsights/ripple'; | ||
export declare const PrivChartPopover: import("react").ForwardRefExoticComponent<JSX.PrivChartPopover & Omit<import("react").HTMLAttributes<HTMLPrivChartPopoverElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLPrivChartPopoverElement>>; | ||
@@ -4,0 +4,0 @@ export declare const PrivDatepicker: import("react").ForwardRefExoticComponent<JSX.PrivDatepicker & Omit<import("react").HTMLAttributes<HTMLPrivDatepickerElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLPrivDatepickerElement>>; |
@@ -5,4 +5,2 @@ /* eslint-disable */ | ||
import { createReactComponent } from './react-component-lib'; | ||
import { defineCustomElements, applyPolyfills } from 'wm-components/loader'; | ||
applyPolyfills().then(function () { return defineCustomElements(); }); | ||
export var PrivChartPopover = /*@__PURE__*/ createReactComponent('priv-chart-popover'); | ||
@@ -9,0 +7,0 @@ export var PrivDatepicker = /*@__PURE__*/ createReactComponent('priv-datepicker'); |
{ | ||
"name": "@watermarkinsights/ripple-react", | ||
"sideEffects": false, | ||
"version": "3.0.0-0", | ||
"version": "3.0.0-1", | ||
"description": "React specific wrappers for Ripple component library", | ||
@@ -6,0 +6,0 @@ "scripts": { |
@@ -1,4 +0,4 @@ | ||
# wm-components-react | ||
# React wrappers | ||
This package is React-specific wrapper created for Watermark's component library so that you can use the components more easily in your React project, i.e., the same way you would any other React component. Implementing the components is slightly different than standard usage, which is documented [here](https://components.watermarkinsights.com/). The main differences: | ||
This package is React-specific wrapper created for Ripple, Watermark's component library. It makes it easier to use the components in React projects, i.e., the same way you would any other React component. Implementing the components is slightly different than standard usage, which is documented [here](https://ripple.watermarkinsights.com/). The main differences: | ||
@@ -9,32 +9,5 @@ - Component names start with an uppercase letter and use CamelCase instead of kebab-case. | ||
## Install | ||
For installation instructions, see https://ripple.watermarkinsights.com/components/installation | ||
This project is based on https://github.com/ionic-team/stencil-ds-plugins-demo/tree/master/packages/component-library-react | ||
1. Add the package as a dev dependency in the package.json file of your React project. | ||
```bash | ||
"wm-components-react": "git+https://gitnyc.taskstream.com/administrator/wm-components-react.git#[version number]" | ||
``` | ||
2. Install the package. (You may get a warning that the package depends on a later version of React. Just ignore this for now.) | ||
```bash | ||
npm install | ||
``` | ||
3. Set the mode and load Material Design icons. The mode should be set to the name of your product, e.g., "via" or "aqua". | ||
```html | ||
<html dir="ltr" lang="en" mode="via"></html> | ||
``` | ||
```html | ||
<head> | ||
<link | ||
href="https://cdn.materialdesignicons.com/3.6.95/css/materialdesignicons.min.css" | ||
rel="stylesheet" | ||
/> | ||
... | ||
</head> | ||
``` | ||
## Usage | ||
@@ -44,3 +17,3 @@ | ||
import React, { Component } from "react"; | ||
import { WmDatepicker } from "wm-components-react/dist"; | ||
import { WmDatepicker } from "@watermarkinsights/ripple-react"; | ||
@@ -59,1 +32,2 @@ class Example extends Component { | ||
``` | ||
70711
886
31