Nomenclature suggestions

mui / toolpad

Toolpad: Full stack components and low-code builder for dashboards and internal apps.

https://mui.com/toolpad/

MIT License

964 stars 243 forks source link

Nomenclature suggestions #1830

Closed prakhargupta1 closed 1 year ago

prakhargupta1 commented 1 year ago

Duplicates

[X] I have searched the existing issues

Latest version

[X] I have tested the latest version

Summary 💡

Based on yesterday's discussion, I am creating this issue to discuss nomenclature of Toolpad queries, APIs.

Current name	Options
serverside javascript	1. Functions 2. Handlers
serverside HTTP request	1. HTTP client 2. API request

Examples 🌈

No response

Motivation 🔦

No response

Janpot commented 1 year ago

For me personally, the following makes most sense:

queries.ts => functions.ts
createQuery => createFunction
Create query options:
- "serverside javascript" => "serverside typescript function"
- "serverside HTTP request" => stays "serverside HTTP request"

apedroferreira commented 1 year ago

queries.ts => functions.ts createQuery => createFunction

Create query options:

"serverside javascript" => "Custom function"
"serverside HTTP request" => "HTTP request"

prakhargupta1 commented 1 year ago

After this is done:

[x] Update Quick start arcade
[x] Change reference everywhere in docs
[x] Update screenshots

apedroferreira commented 1 year ago

Reopening just until the arcade is updated, then we can close this.

prakhargupta1 commented 1 year ago

Arcade updated. Looks like due to some update on their side, old and new arcades have some difference in the dimensions. This led to some images getting cropped. Will try to fix it later.