-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from js-template/1x-docs-components
components docs updated
- Loading branch information
Showing
34 changed files
with
1,078 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,7 +17,7 @@ | |
"toc": true | ||
} | ||
}, | ||
"packages": { | ||
"components": { | ||
"title": "Components", | ||
"theme": { | ||
"toc": true | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"header": { | ||
"title": "Headers", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"blocks": { | ||
"title": "Blocks", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"widgets": { | ||
"title": "Widgets", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"configs": { | ||
"title": "Config", | ||
"theme": { | ||
"toc": true | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
{ | ||
"banner": { | ||
"title": "Banner", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"breadcrumbs": { | ||
"title": "Breadcrumbs", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"category-card": { | ||
"title": "Category Card", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"content-box": { | ||
"title": "Content Box", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"image-carousel": { | ||
"title": "Image Carousel", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"image-gallary": { | ||
"title": "Image Gallary", | ||
"theme": { | ||
"toc": true | ||
} | ||
}, | ||
"review-block": { | ||
"title": "Review Block", | ||
"theme": { | ||
"toc": true | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Banner Component | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Banner` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"content": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.section-title" | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
}, | ||
"variation": { | ||
"type": "enumeration", | ||
"enum": [ | ||
"simple", | ||
"center", | ||
"bottom right", | ||
"left right", | ||
"box left", | ||
"box right", | ||
"circle" | ||
], | ||
"default": "simple" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
{/* ## API Documentation | ||
- **Request**: [Banner Component Request API Documentation](#) */} | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Blog Post | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Blog Post` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"content": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.section-title" | ||
}, | ||
"posts": { | ||
"type": "relation", | ||
"relation": "oneToMany", | ||
"target": "plugin::padma-backend.post" | ||
}, | ||
"empty": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "shared.empty" | ||
}, | ||
"button": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.link" | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
{/* ## API Documentation | ||
- **Request**: [Banner Component Request API Documentation](#) */} | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Breadcrumbs | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Breadcrumbs` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"separator": { | ||
"type": "string", | ||
"default": "/", | ||
"required": true | ||
}, | ||
"variation": { | ||
"type": "enumeration", | ||
"enum": ["default", "simple", "minimal"], | ||
"default": "default" | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
}, | ||
"items": { | ||
"type": "json" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
{/* ## API Documentation | ||
- **Request**: [Banner Component Request API Documentation](#) */} | ||
|
||
|
||
|
||
|
44 changes: 44 additions & 0 deletions
44
docs/docs/pages/plugins/components/blocks/category-card.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Category Cards | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Category Card` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"content": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.section-title" | ||
}, | ||
"category": { | ||
"type": "relation", | ||
"relation": "oneToMany", | ||
"target": "plugin::padma-backend.category" | ||
}, | ||
"empty": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "shared.empty" | ||
}, | ||
"button": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.link" | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
} | ||
} | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Content Box | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Content Box` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"content": { | ||
"type": "component", | ||
"repeatable": true, | ||
"component": "config.section-title" | ||
}, | ||
"icon_box": { | ||
"type": "component", | ||
"repeatable": true, | ||
"component": "component.icon-box" | ||
}, | ||
"empty": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "shared.empty" | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
{/* ## API Documentation | ||
- **Request**: [Banner Component Request API Documentation](#) */} | ||
|
||
|
||
|
||
|
53 changes: 53 additions & 0 deletions
53
docs/docs/pages/plugins/components/blocks/image-carousel.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
|
||
import { Callout } from 'nextra/components' | ||
|
||
# Image Carousel | ||
Version- `1.0.0` | ||
|
||
## Uses | ||
The `Image Carousel` component is used within dynamic collections of `public-page`. | ||
|
||
|
||
## Attributes | ||
|
||
```json | ||
{ | ||
"attributes": { | ||
"cards": { | ||
"type": "component", | ||
"repeatable": true, | ||
"component": "config.carousel-card", | ||
"required": true | ||
}, | ||
"style": { | ||
"type": "component", | ||
"repeatable": false, | ||
"component": "config.style-section" | ||
}, | ||
"autoplay": { | ||
"type": "boolean", | ||
"default": true, | ||
"required": false | ||
}, | ||
"interval": { | ||
"type": "integer", | ||
"default": 3000, | ||
"required": false, | ||
"description": "Time in milliseconds for slide interval when autoplay is enabled." | ||
}, | ||
"variation": { | ||
"type": "enumeration", | ||
"enum": ["default", "fade", "slide", "zoom"], | ||
"default": "default" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
{/* ## API Documentation | ||
- **Request**: [Banner Component Request API Documentation](#) */} | ||
|
||
|
||
|
||
|
Oops, something went wrong.