Orange-OpenSource / Orange-OpenSource/ouds-android

In `library`, add `list item` component v0.3

Open
#1,402 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

⚛️ component 📖 documentation 📱 demo app 🧰 library
Dominant language
Kotlin
Stars
22
Forks
5
Avg merge
3d 12h
Merged PRs (30d)
30

Description

Description

As a user of the OUDS library
I want to be able to use the component
So that I can add an OUDS component in my own projects

As a user of the library
I want to be able to use the component
So that I have access to the documentation on how to use it

As a user of the Design System Toolbox pp
I want to access the Component
So that I can understand how to use it:

  • while using the design system toolbox app I can interact with the available options and observe the changes on the component itself
  • I can see the code associated to the component customization
  • I can copy and paste the code from the app based on the selected customization
  • or when looking into the code of the app itself, I would also understand how to use it

Figma reference

Details

Verbatims from @MaximeTonnerre about prioritization of the component below.
Note that a component in version 0 must be seen as draft.

v0.3

Trailing: Badge + Tag

Specific use cases

  • Let users add a custom view instead of image / icon in leading position but with sizes constrained to the 3 available
  • Let users change the color of the texts (or maybe at least the text above)

Other notes

Here is an initial list of usage rules that we can already identify:

The management of the “Rounded corner” variant is the same as for the other affected components. It is not possible to have both renderings on the same product (except for the “Grouped + Divider” use case where the rounded corner is not applicable).
The “Size” variant must be applied to the entire list (the “Grouped” use case).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing components in the OUDS library and the Design System Toolbox app, using the linked Figma reference to understand the list item design. Done means the v0.3 trailing Badge + Tag variant, constrained custom leading view, text-color options, interactive customization, copyable usage code, and component documentation are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, kotlin
Domain
design, documentation, mobile
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.