Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Add in code documentation and rename params for each component #514

Merged
merged 59 commits into from
Nov 19, 2024

Conversation

tilucasoli
Copy link
Collaborator

Description

  • Add in code comments for each component and improve Spec params names

Changes

  • Add comments and rename params

Review Checklist

  • Testing: Have you tested your changes, including unit tests and integration tests for affected code?
  • Breaking Changes: Does this change introduce breaking changes affecting existing code or users?
  • Documentation Updates: Are all relevant documentation files (e.g. README, API docs) updated to reflect the changes in this PR?
  • Website Updates: Is the website containing the updates you make on documentation?

Copy link

vercel bot commented Nov 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
mix-docs ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2024 6:32pm

@github-actions github-actions bot added documentation Improvements or additions to documentation examples remix labels Nov 4, 2024
@tilucasoli tilucasoli force-pushed the doc/remix-components branch from 27d0c2c to 2a00103 Compare November 7, 2024 19:35

/// {@macro accordion_spec_of}
static const of = _$AccordionSpec.of;

static const from = _$AccordionSpec.from;

const AccordionSpec({
BoxSpec? container,
FlexBoxSpec? flexContainer,
Copy link
Member

Choose a reason for hiding this comment

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

Lets change this to container

final IconData? iconRight;

/// {@template remix.component.onPressed}
Copy link
Member

Choose a reason for hiding this comment

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

Let's move template definitions to the docs file

titleStyle,
descriptionStyle,
actionsFlex,
actionsLayout,
Copy link
Member

Choose a reason for hiding this comment

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

Change this to actionsContainer and make it a FlexBox

BoxSpec? outerContainer,
FlexSpec? contentLayout,
FlexSpec? titleSubtitleLayout,
FlexBoxSpec? flexContainer,
Copy link
Member

Choose a reason for hiding this comment

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

Changes this to container

titleSubtitleLayout,
contentLayout,
titleSubtitleFlex,
flexContainer,
Copy link
Member

Choose a reason for hiding this comment

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

Change this to container

@@ -33,13 +33,13 @@ class SegmentedControlSpec extends Spec<SegmentedControlSpec>

const SegmentedControlSpec({
BoxSpec? container,
FlexSpec? flex,
FlexSpec? layout,
Copy link
Member

Choose a reason for hiding this comment

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

Combine this into the container and make it a FlexBoxSpec

@github-actions github-actions bot added the mix label Nov 15, 2024
Copy link
Member

@leoafarias leoafarias left a comment

Choose a reason for hiding this comment

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

LGTM

@tilucasoli tilucasoli merged commit 0c1b5cd into main Nov 19, 2024
6 checks passed
@tilucasoli tilucasoli deleted the doc/remix-components branch November 19, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples mix remix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants