Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

[compact-interactive-list] Initial component setup #1861

Merged
merged 8 commits into from
Oct 27, 2023

Conversation

adoroshk
Copy link
Contributor

Summary

This PR sets up the base terra-compact-interactive-list component to prepare for development.

These changes are based on the following PRs:

Testing

The initial WDIO and Jest test were set up, but they don't have actual tests yet and will be updated with added functionality.
This change was tested using:

  • WDIO
  • Jest
  • Visual testing (please attach a screenshot or recording)
  • Other (please describe below)
  • No tests are needed

Reviews

In addition to engineering reviews, this PR needs:

  • UX review
  • Accessibility review
  • Functional review

Additional Details

This PR is a part of:

UXPLATFORM-9557

@github-actions
Copy link
Contributor

github-actions bot commented Oct 26, 2023

Fails
🚫 Please include a CHANGELOG entry for each changed package this PR. Looks like a CHANGELOG entry is missing for:
  • terra-table

Generated by 🚫 dangerJS against 862cf1d

@adoroshk
Copy link
Contributor Author

The terra-table changes are only for fixing broken links to the terra-framework repo in terra-table package.json, and I think they don't need a changelog entry, but correct me if I am wrong

packages/terra-compact-interactive-list/NOTICE Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

There are a bunch of extra entries in this file but I'm wondering if we should use the files property instead of npmignore. Files works as a whitelist while npmignore works as a blacklist. It's easier to think of what files you want vs accounting for any potential files you don't want.
@sycombs thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

If we use the files property instead of .npmignore, we just need to be careful about making sure to include everything needed. With the @cerner/terra-pills issue some time back, we were inadvertently omitting the CHANGELOG from releases since CHANGELOGs aren't automatically included (for npm@9).

For now I think we can continue using .npmignore for this change at least. My only concern with switching to using files would be increasing bloat in package.json, but it's not a big concern.

Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we will need them in the future, but you are right, no need to have then at that point. Removed: 4392403

Copy link
Contributor

Choose a reason for hiding this comment

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

and this one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

same as above, removed in 4392403

Comment on lines 27 to 32
/**
* Boolean indicating whether or not the table columns should be displayed. Setting the value to false will hide the columns,
* but the voice reader will use the column header values for a11y.
*/
hasColumnHeaders: PropTypes.bool,
};
Copy link
Contributor

Choose a reason for hiding this comment

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

is this prop correct?

Copy link
Contributor Author

@adoroshk adoroshk Oct 26, 2023

Choose a reason for hiding this comment

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

I edited the prop to default to false and edited description per that. Currently the plan is to not display the headers, but allow users to turn them on if they need them.

UPD: I realized we might want to take care of the column headers later in the development process, so I removed it for now in 862cf1d

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need these shapes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess we need the shapes. I edited them a bit though: 4392403

@github-actions github-actions bot temporarily deployed to preview-pr-1861 October 27, 2023 16:49 Destroyed
@adoroshk adoroshk merged commit 969d3d7 into main Oct 27, 2023
@adoroshk adoroshk deleted the compact_interactive_list_component_setup branch October 27, 2023 21:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants