h2oai/wave

Give all widgets the name parameter

Open

#2,350 创建于 2024年6月11日

在 GitHub 查看
 (4 评论) (2 反应) (0 负责人)Python (3,677 star) (279 fork)batch import
chorefeaturegood first issue

描述

Is your feature request related to a problem? Please describe

It is very common to update parameters of components throughout the app usage lifecycle. This is most easily done with the name parameter, but not every component has that parameter. This means new-er users to the framework will learn about updating with the name component: q.page["test"].my_component.content = "hey" but then have no idea what to do when name is not there.

They can ("of course") use the old index method: q.page["test"].items[2].textbox.value="hey" but this is harder and often Wave users that joined after the 1.0.0 release will not know about this.

Describe the solution you'd like

  • An audit of all components to make a list of everything that does not have name as a parameter
  • Add name as a parameter to all of these

Describe alternatives you've considered

  • Leave things as is, monitor chats and teach people about the old method
  • Write new docs with key words that people might find when they try to update things like image

Additional context

Resolved question: https://github.com/h2oai/wave/discussions/2338

贡献者指南

技术栈
pythonr
领域
backend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonWave framework basicsGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Start by auditing all Wave components to identify those missing the `name` parameter. Look for component class definitions in the source code (likely under `wave/widgets/` or similar). Add the `name` parameter consistently following existing patterns. The discussion at https://github.com/h2oai/wave/discussions/2338 provides background. Review comments on the issue for any maintainer guidance on scope or approach.
Give all widgets the name parameter · h2oai/wave#2350 | Good First Issue