Skip to content

Conversation

@evanyan13
Copy link
Contributor

@evanyan13 evanyan13 commented Apr 16, 2025

  • Update code examples for CioPlp component
    • Basic Example
    • Render Props Example

@evanyan13 evanyan13 self-assigned this Apr 16, 2025
@evanyan13 evanyan13 requested a review from a team as a code owner April 16, 2025 23:02
@evanyan13 evanyan13 changed the title [CI-4371] [CI-4371] Update CioPlp Code Example Apr 16, 2025
@evanyan13 evanyan13 changed the title [CI-4371] Update CioPlp Code Example [CI-4371] Update Code Example - CioPlp Apr 17, 2025
@evanyan13 evanyan13 changed the title [CI-4371] Update Code Example - CioPlp [CI-4303] Update Code Example - CioPlp Apr 17, 2025
Copy link
Contributor

@mocca102 mocca102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked when you added instructions for how to view the example and see the component in action in CioPlp? Can we do something similar here? Maybe an example with search or browse @evanyan13

To view the examples and see this component in action, append your URL with /group_id/1035, as this corresponds to a Browse Page.

Copy link
Contributor

@mocca102 mocca102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@Mudaafi Mudaafi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove types from the code examples. It's best if it works OOTB in a js env. We already have the type definition in the earlier table, but we can also include it in the individual code examples descriptions. E.g.

> #### `getUrl`
- Default Implementation
- setUrl -> (newEncodedUrlState: string) => void

  ```javascript
....

Copy link
Contributor

@Mudaafi Mudaafi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks for making the changes

@evanyan13 evanyan13 merged commit 95c1e8c into main May 1, 2025
10 of 11 checks passed
@evanyan13 evanyan13 deleted the ci-4371-os-plp-ui-docs-fix-cioplp-code-examples branch May 1, 2025 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants