Skip to content

Commit e97e39b

Browse files
authored
Merge pull request #168 from devforth/inline-create
docs: Add documentation for InlineCreatePlugin and ListInPlaceEditPlugin
2 parents b0d5737 + 40e3e8d commit e97e39b

File tree

5 files changed

+72
-3
lines changed

5 files changed

+72
-3
lines changed

adminforth/documentation/blog/authors.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@ ivanb:
33
title: Maintainer of AdminForth
44
url: https://github.com/ivictbor
55
image_url: https://avatars.githubusercontent.com/u/1838656?v=4
6-
76
mpipkun:
8-
name: Maxim Pipkun
7+
name: Maxim Pypkun
98
title: Developer of AdminForth
109
url: https://github.com/NoOne7135
11-
image_url: https://avatars.githubusercontent.com/u/120279695?v=4
10+
image_url: https://avatars.githubusercontent.com/u/120279695?v=4
11+
vkulyk:
12+
name: Vitalii Kulyk
13+
title: Developer of AdminForth
14+
url: https://github.com/SerVitasik
15+
image_url: https://avatars.githubusercontent.com/u/87546293?v=4
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Inline Create
2+
3+
The Inline Create plugin enables inline create in AdminForth, allowing users to create records directly in the list view.
4+
5+
## Installation
6+
7+
To install the plugin:
8+
9+
```bash
10+
npm install @adminforth/inline-create --save
11+
```
12+
13+
14+
### Usage
15+
16+
Configure the plugin in your apartments resource file:
17+
18+
```typescript title="./resources/apartments.ts"
19+
import InlineCreatePlugin from '@adminforth/inline-create';
20+
21+
// ... existing resource configuration ...
22+
23+
plugins: [
24+
new InlineCreatePlugin({}),
25+
]
26+
```
27+
28+
Here is how it looks:
29+
30+
![alt text](inline-create.png)
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# List in place edit
2+
3+
The List in Place Edit plugin allows you to edit records directly in the list view.
4+
5+
## Usage
6+
7+
First, install the plugin:
8+
9+
```bash
10+
npm i @adminforth/list-in-place-edit --save
11+
```
12+
13+
Import plugin:
14+
15+
```ts title="./resources/apartments.ts"
16+
import ListInPlaceEditPlugin from "@adminforth/list-in-place-edit";
17+
```
18+
19+
Now instantiate the plugin and add it to the configuration:
20+
21+
```ts title="./resources/apartments.ts"
22+
23+
{
24+
...
25+
plugins: [
26+
new ListInPlaceEditPlugin({
27+
columns: ["title", "description"],
28+
}),
29+
],
30+
}
31+
```
32+
33+
Here is how it looks:
34+
35+
![alt text](list-in-place.png)
239 KB
Loading
214 KB
Loading

0 commit comments

Comments
 (0)