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

Angular: Add type support for Angular's output signals #26546

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

valentinpalkovic
Copy link
Contributor

Closes N/A

What I did

Support the new signal-based output function in Angular 17.3 and upwards in Storybook's helper types as Meta, StoryObj or StoryFn. I also ensured that TypeScript doesn't complain in Angular versions that don't support this feature.

Please be aware that controls might not reflect the proper types when Signals are used. For component and property analysis, we are relying on Compodoc. Compodoc doesn't support the new output signal yet.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Run a latest Angular sandbox (angular-cli/default-ts)
  2. Open the story src/stories/frameworks/angular_angular-cli-prerelease/signal/button.stories.ts
  3. Make sure that, for example the type for the onClick argument gets correctly inferred
Bildschirmfoto 2024-03-18 um 08 48 20

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@valentinpalkovic valentinpalkovic self-assigned this Mar 18, 2024
@valentinpalkovic valentinpalkovic added feature request angular ci:daily Run the CI jobs that normally run in the daily job. labels Mar 18, 2024
Copy link

nx-cloud bot commented Mar 18, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 7a0a1c7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Support the new signal-based output function in Angular 17.3 and upwards in Storybook's helper types as StoryObj or StoryFn. I also ensured that TypeScript doesn't complain in Angular versions that don't support this feature.

Please be aware, that controls might not reflect the proper types when Signals are used. For component and property analysis, we are relying on Compodoc. Compodoc doesn't support the new output signal yet.
@valentinpalkovic valentinpalkovic force-pushed the valentin/add-output-support-for-angular branch from ea048d0 to 7a0a1c7 Compare March 18, 2024 08:05
@valentinpalkovic valentinpalkovic marked this pull request as ready for review March 18, 2024 08:06
Base automatically changed from valentin/add-input-support-for-angular to next March 20, 2024 09:48
@valentinpalkovic valentinpalkovic merged commit 2eaf4a6 into next Mar 20, 2024
99 of 112 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/add-output-support-for-angular branch March 20, 2024 09:59
@github-actions github-actions bot mentioned this pull request Mar 20, 2024
11 tasks
@valentinpalkovic valentinpalkovic changed the title Angular: Add support for Angular's output signals Angular: Add type support for Angular's output signals Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
angular ci:daily Run the CI jobs that normally run in the daily job. feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants