Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implemented usage documentation for dnn-checkbox #1036

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Implemented usage documentation for dnn-checkbox #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions packages/stencil-library/custom-elements.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"type": {
"text": "\"button\" | \"reset\" | \"submit\""
},
"description": "Optional button type,\ncan be either submit, reset or button and defaults to button if not specified.\nWarning: DNN wraps the whole page in a form, only use this if you are handling\nform submission manually.",
"description": "Optional button type,\r\ncan be either submit, reset or button and defaults to button if not specified.\r\nWarning: DNN wraps the whole page in a form, only use this if you are handling\r\nform submission manually.",
"default": "'button'",
"required": false
},
Expand All @@ -88,7 +88,7 @@
"type": {
"text": "\"danger\" | \"primary\" | \"secondary\" | \"tertiary\""
},
"description": "Optional button style,\ncan be either primary, secondary or tertiary or danger and defaults to primary if not specified",
"description": "Optional button style,\r\ncan be either primary, secondary or tertiary or danger and defaults to primary if not specified",
"default": "'primary'",
"required": false
}
Expand Down Expand Up @@ -447,7 +447,7 @@
"text": "{ contrast: string; preview: string; cancel: string; confirm: string; normal: string; light: string; dark: string; }"
},
"description": "Can be used to customize the text language.",
"default": "{\n contrast: \"Contrast\",\n preview: \"Preview\",\n cancel: \"Cancel\",\n confirm: \"Confirm\",\n normal: \"Normal\",\n light: \"Light\",\n dark: \"Dark\",\n }",
"default": "{\r\n contrast: \"Contrast\",\r\n preview: \"Preview\",\r\n cancel: \"Cancel\",\r\n confirm: \"Confirm\",\r\n normal: \"Normal\",\r\n light: \"Light\",\r\n dark: \"Dark\",\r\n }",
"required": false
}
],
Expand Down Expand Up @@ -563,7 +563,7 @@
"type": {
"text": "boolean"
},
"description": "If true, will allow the user to take a snapshot\nusing the device camera. (only works over https).",
"description": "If true, will allow the user to take a snapshot\r\nusing the device camera. (only works over https).",
"default": "false",
"required": false
},
Expand All @@ -572,7 +572,7 @@
"type": {
"text": "number"
},
"description": "Specifies the jpeg quality for when the device\ncamera is used to generate a picture.\nNeeds to be a number between 0 and 1 and defaults to 0.8",
"description": "Specifies the jpeg quality for when the device\r\ncamera is used to generate a picture.\r\nNeeds to be a number between 0 and 1 and defaults to 0.8",
"default": "0.8",
"required": false
},
Expand Down Expand Up @@ -600,7 +600,7 @@
"type": {
"text": "string[]"
},
"description": "A list of allowed file extensions.\nIf not specified, any file is allowed.\nEx: [\"jpg\", \"jpeg\", \"gif\", \"png\"]",
"description": "A list of allowed file extensions.\r\nIf not specified, any file is allowed.\r\nEx: [\"jpg\", \"jpeg\", \"gif\", \"png\"]",
"required": false
},
{
Expand Down Expand Up @@ -816,7 +816,7 @@
"kind": "class",
"name": "dnn-image-cropper.tsx",
"tagName": "dnn-image-cropper",
"description": "Allows cropping an image in-browser with the option to enforce a specific final size.\nAll computation happens in the browser and the final image is emmited\nin an event that has a data-url of the image.",
"description": "Allows cropping an image in-browser with the option to enforce a specific final size.\r\nAll computation happens in the browser and the final image is emmited\r\nin an event that has a data-url of the image.",
"attributes": [
{
"name": "height",
Expand Down Expand Up @@ -868,7 +868,7 @@
"type": {
"text": "ImageCropperResx"
},
"description": "Can be used to customize controls text.\nSome values support tokens, see default values for examples.",
"description": "Can be used to customize controls text.\r\nSome values support tokens, see default values for examples.",
"required": false
},
{
Expand Down Expand Up @@ -1144,7 +1144,7 @@
"type": {
"text": "string"
},
"description": "Optionally pass the aria-label text for the close button.\nDefaults to \"Close modal\" if not provided.",
"description": "Optionally pass the aria-label text for the close button.\r\nDefaults to \"Close modal\" if not provided.",
"default": "\"Close modal\"",
"required": false
},
Expand All @@ -1162,7 +1162,7 @@
"type": {
"text": "boolean"
},
"description": "Optionally you can pass false to not show the close button.\nIf you decide to do so, you should either not also prevent dismissal by clicking the backdrop\nor provide your own dismissal logic in the modal content.",
"description": "Optionally you can pass false to not show the close button.\r\nIf you decide to do so, you should either not also prevent dismissal by clicking the backdrop\r\nor provide your own dismissal logic in the modal content.",
"default": "true",
"required": false
},
Expand Down Expand Up @@ -1535,7 +1535,7 @@
"type": {
"text": "string"
},
"description": "Fires up each time the search query changes.\nThe data passed is the new query."
"description": "Fires up each time the search query changes.\r\nThe data passed is the new query."
}
],
"slots": [],
Expand Down Expand Up @@ -2124,7 +2124,7 @@
"kind": "class",
"name": "dnn-vertical-splitview.tsx",
"tagName": "dnn-vertical-splitview",
"description": "This allows splitting a UI into vertical adjustable panels, the splitter itself is not part of this component.\n- The content for the left part should be injected in the `left` slot.\n- The content for the right part should be injected in the `right` slot.\n- The content for the actual splitter should go in the default slot and other UI elements can be injected as long as you handle their behaviour, by default only the drag behavior is implemented in the component.",
"description": "This allows splitting a UI into vertical adjustable panels, the splitter itself is not part of this component.\r\n- The content for the left part should be injected in the `left` slot.\r\n- The content for the right part should be injected in the `right` slot.\r\n- The content for the actual splitter should go in the default slot and other UI elements can be injected as long as you handle their behaviour, by default only the drag behavior is implemented in the component.",
"attributes": [
{
"name": "split-width-percentage",
Expand Down
85 changes: 82 additions & 3 deletions packages/stencil-library/licenses.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,94 @@
{
"@babel/[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/babel/babel",
"publisher": "Sebastian McKenzie",
"email": "[email protected]",
"path": "node_modules\\@babel\\code-frame",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\@babel\\code-frame\\LICENSE"
},
"@dnncommunity/[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/dnncommunity/dnn-elements",
"path": "",
"licenseFile": "D:\\dnn-elements\\dnn-elements\\packages\\stencil-library\\README.md"
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\README.md"
},
"@eslint/[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/eslint/eslintrc",
"publisher": "Nicholas C. Zakas",
"path": "node_modules\\@eslint\\eslintrc",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\@eslint\\eslintrc\\LICENSE"
},
"@humanwhocodes/[email protected]": {
"licenses": "Apache-2.0",
"repository": "https://github.com/humanwhocodes/config-array",
"publisher": "Nicholas C. Zakas",
"path": "node_modules\\@humanwhocodes\\config-array",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\@humanwhocodes\\config-array\\LICENSE"
},
"@stencil/[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/ionic-team/stencil-eslint",
"path": "node_modules\\@stencil\\eslint-plugin",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\@stencil\\eslint-plugin\\LICENSE.md"
},
"[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/mysticatea/eslint-utils",
"publisher": "Toru Nagashima",
"path": "node_modules\\eslint\\node_modules\\eslint-utils",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\eslint\\node_modules\\eslint-utils\\LICENSE"
},
"[email protected]": {
"licenses": "Apache-2.0",
"repository": "https://github.com/eslint/eslint-visitor-keys",
"publisher": "Toru Nagashima",
"path": "node_modules\\espree\\node_modules\\eslint-visitor-keys",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\espree\\node_modules\\eslint-visitor-keys\\LICENSE"
},
"[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/eslint/eslint",
"publisher": "Nicholas C. Zakas",
"email": "[email protected]",
"path": "node_modules\\eslint",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\eslint\\LICENSE"
},
"[email protected]": {
"licenses": "BSD-2-Clause",
"repository": "https://github.com/eslint/espree",
"publisher": "Nicholas C. Zakas",
"email": "[email protected]",
"path": "node_modules\\espree",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\espree\\LICENSE"
},
"[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/kaelzhang/node-ignore",
"publisher": "kael",
"path": "node_modules\\ignore",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\ignore\\LICENSE-MIT"
},
"[email protected]": {
"licenses": "0BSD",
"repository": "https://github.com/Microsoft/tslib",
"publisher": "Microsoft Corp.",
"path": "node_modules\\tslib",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\tslib\\LICENSE.txt"
},
"[email protected]": {
"licenses": "MIT",
"repository": "https://github.com/ajafff/tsutils",
"publisher": "Klaus Meinhardt",
"path": "node_modules\\tsutils",
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\tsutils\\LICENSE"
},
"typescript@5.2.2": {
"typescript@4.9.5": {
"licenses": "Apache-2.0",
"repository": "https://github.com/Microsoft/TypeScript",
"publisher": "Microsoft Corp.",
"path": "node_modules\\typescript",
"licenseFile": "D:\\dnn-elements\\dnn-elements\\packages\\stencil-library\\node_modules\\typescript\\LICENSE.txt"
"licenseFile": "C:\\dev\\dnn-elements\\packages\\stencil-library\\node_modules\\typescript\\LICENSE.txt"
}
}
27 changes: 27 additions & 0 deletions packages/stencil-library/src/components/dnn-checkbox/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,33 @@
<!-- Auto Generated Below -->


## Usage

### HTML

```html
<dnn-checkbox
checked="unchecked"
name="agree"
value="1"
use-intermediate="false">
</dnn-checkbox>
```


### JSX-TSX

```tsx
<dnn-checkbox
checked="unchecked"
name="agree"
value="1"
useIntermediate="false">
</dnn-checkbox>
```



## Properties

| Property | Attribute | Description | Type | Default |
Expand Down
8 changes: 8 additions & 0 deletions packages/stencil-library/src/components/dnn-checkbox/usage/HTML.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```html
<dnn-checkbox
checked="unchecked"
name="agree"
value="1"
use-intermediate="false">
</dnn-checkbox>
```
8 changes: 8 additions & 0 deletions packages/stencil-library/src/components/dnn-checkbox/usage/JSX-TSX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```tsx
<dnn-checkbox
checked="unchecked"
name="agree"
value="1"
useIntermediate="false">
</dnn-checkbox>
```
16 changes: 8 additions & 8 deletions packages/stencil-library/vscode-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
},
{
"name": "form-button-type",
"description": "Optional button type,\ncan be either submit, reset or button and defaults to button if not specified.\nWarning: DNN wraps the whole page in a form, only use this if you are handling\nform submission manually.",
"description": "Optional button type,\r\ncan be either submit, reset or button and defaults to button if not specified.\r\nWarning: DNN wraps the whole page in a form, only use this if you are handling\r\nform submission manually.",
"values": [
{
"name": "button"
Expand Down Expand Up @@ -64,7 +64,7 @@
},
{
"name": "type",
"description": "Optional button style,\ncan be either primary, secondary or tertiary or danger and defaults to primary if not specified",
"description": "Optional button style,\r\ncan be either primary, secondary or tertiary or danger and defaults to primary if not specified",
"values": [
{
"name": "danger"
Expand Down Expand Up @@ -235,11 +235,11 @@
"attributes": [
{
"name": "allow-camera-mode",
"description": "If true, will allow the user to take a snapshot\nusing the device camera. (only works over https)."
"description": "If true, will allow the user to take a snapshot\r\nusing the device camera. (only works over https)."
},
{
"name": "capture-quality",
"description": "Specifies the jpeg quality for when the device\ncamera is used to generate a picture.\nNeeds to be a number between 0 and 1 and defaults to 0.8"
"description": "Specifies the jpeg quality for when the device\r\ncamera is used to generate a picture.\r\nNeeds to be a number between 0 and 1 and defaults to 0.8"
},
{
"name": "max-file-size",
Expand Down Expand Up @@ -320,7 +320,7 @@
"name": "dnn-image-cropper",
"description": {
"kind": "markdown",
"value": "Allows cropping an image in-browser with the option to enforce a specific final size.\nAll computation happens in the browser and the final image is emmited\nin an event that has a data-url of the image."
"value": "Allows cropping an image in-browser with the option to enforce a specific final size.\r\nAll computation happens in the browser and the final image is emmited\r\nin an event that has a data-url of the image."
},
"attributes": [
{
Expand Down Expand Up @@ -471,15 +471,15 @@
},
{
"name": "close-text",
"description": "Optionally pass the aria-label text for the close button.\nDefaults to \"Close modal\" if not provided."
"description": "Optionally pass the aria-label text for the close button.\r\nDefaults to \"Close modal\" if not provided."
},
{
"name": "resizable",
"description": "If set to true, the modal becomes resizable."
},
{
"name": "show-close-button",
"description": "Optionally you can pass false to not show the close button.\nIf you decide to do so, you should either not also prevent dismissal by clicking the backdrop\nor provide your own dismissal logic in the modal content."
"description": "Optionally you can pass false to not show the close button.\r\nIf you decide to do so, you should either not also prevent dismissal by clicking the backdrop\r\nor provide your own dismissal logic in the modal content."
},
{
"name": "visible",
Expand Down Expand Up @@ -896,7 +896,7 @@
"name": "dnn-vertical-splitview",
"description": {
"kind": "markdown",
"value": "This allows splitting a UI into vertical adjustable panels, the splitter itself is not part of this component.\n- The content for the left part should be injected in the `left` slot.\n- The content for the right part should be injected in the `right` slot.\n- The content for the actual splitter should go in the default slot and other UI elements can be injected as long as you handle their behaviour, by default only the drag behavior is implemented in the component."
"value": "This allows splitting a UI into vertical adjustable panels, the splitter itself is not part of this component.\r\n- The content for the left part should be injected in the `left` slot.\r\n- The content for the right part should be injected in the `right` slot.\r\n- The content for the actual splitter should go in the default slot and other UI elements can be injected as long as you handle their behaviour, by default only the drag behavior is implemented in the component."
},
"attributes": [
{
Expand Down
Loading