Skip to content

Commit

Permalink
Merge pull request #906 from DNNCommunity/release/0.23.1
Browse files Browse the repository at this point in the history
Released v0.23.1
  • Loading branch information
valadas authored Nov 29, 2023
2 parents 60b75e4 + 1dcefe2 commit 4ce4164
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 14 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,35 @@
![npm (scoped with tag)](https://img.shields.io/npm/v/@dnncommunity/dnn-elements/latest)
![npm (scoped with tag)](https://img.shields.io/npm/v/@dnncommunity/dnn-elements/next)

# Dnn custom HTML elements
# dnn-elements (HTML Custom Elements)
This is a collection of reusable HTML custom elements (WebComponents) for Dnn.

This is a collection of reusable HTML elements (WebComponents) for Dnn.

# View demo
A [demo site](https://DnnCommunity.github.io/dnn-elements/) is available to play with each component. Open the developer panel in your browser to inspect what various component events do.

# Stencil
## DEMO
A [demo site](https://dnncommunity.github.io/dnn-elements/) is available as a playground for all current components, along with documentation.

## Stencil
Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

## Using these components
Run `npm i @dnncommunity/dnn-elements`
## Usage (No Framework)
### npm
`npm install @dnncommunity/dnn-elements`

### yarn
`yarn add @dnncommunity/dnn-elements`

## Usage (React)
### npm
`npm install @dnncommunity/dnn-elements-react`

### yarn
`yarn add @dnncommunity/dnn-elements-react`

## Usage (Angular)
Stay tuned - coming soon.

Usage of each component is documented in the component folder rigth here on github with some code samples too.
## Usage (Individual Components)
Usage of each component is documented within the component folder right here on GitHub, along with some code samples too.
8 changes: 4 additions & 4 deletions packages/react-library/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# `dnn-elements-react`

A set of DNN pure WebComponents (custom elements) with wrappers for usage in React.
This is a collection of pure web components (custom elements) for use within DNN Platform or custom extensions for DNN. These can even be used in projects outside of the DNN purview, though some are unique for the DNN experience. The web components in `dnn-elements-react` are framework specific to React. For framework agnostic web components, you can use `dnn-elements`.

## Usage
In your React project run
### npm
`npm install @dnncommunity/dnn-elements-react`
or

### yarn
`yarn add @dnncommunity/dnn-elements-react`

```
Expand Down
22 changes: 22 additions & 0 deletions packages/stencil-library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# `dnn-elements`
This is a collection of pure web components (custom elements) for use within DNN Platform or custom extensions for DNN. These can even be used in projects outside of the DNN purview, though some are unique for the DNN experience. The web components in `dnn-elements` are framework agnostic. For framework specific web components (e.g., React), you can use `dnn-elements-<framework>` (currently `dnn-element-react` is the only framework specific version, but there are plans to support Angular soon).

## Usage
### npm
`npm install @dnncommunity/dnn-elements`

### yarn
`yarn add @dnncommunity/dnn-elements`

```
// my-component.tsx
import '@dnncommunity/dnn-elements';
render() {
return (
<Host>
<dnn-button type="secondary">Secondary Button</dnn-button>
</Host>
);
}
```

0 comments on commit 4ce4164

Please sign in to comment.