decaporg / decaporg/decap-cms

API Overhaul: Rename 'widget' to 'field type'

Open
#3,719 1 comment 2 reactions 0 assignees View on GitHub
type: chore
Dominant language
JavaScript
Stars
19.4k
Forks
3.1k
Avg merge
1d 14h
Merged PRs (30d)
9

Description

As part of the API overhaul effort per #1041 and #1409, I propose we move away from the somewhat ambiguous term “widget” in reference to field types within the editor. The term widget can be synonymous with sections within a dashboard and as we plan on introducing a dashboard view into our UI, it may be a bit confusing, especially for first-time users.

We currently call them fields within the config file. So I'd imagine it may be more clear if we changed widget to type in each field in the fields array to avoid confusion in the future.

Likewise instead of `registerWidget` we might rename this `registerFieldType` making way for `registerDashboardWidget`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.