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

RTT Feature Storybook #5593

Merged
merged 6 commits into from
Jan 29, 2025
Merged

RTT Feature Storybook #5593

merged 6 commits into from
Jan 29, 2025

Conversation

carocao-msft
Copy link
Contributor

@carocao-msft carocao-msft commented Jan 29, 2025

What

  1. Moved internal stories out to be external.

  2. Fixed a few bugs in StartRealTimeTextButton (onLabel --> label so the label displays when setting showLabel to true)

  3. A few bugs in Captions Banner Component : auto scroll for RTT, placeholder for textfield, display content when caption is on but start captions in progress is false

  4. Created new stories for:

    • Real Time Text concept
    • Real Time Text Start Button
    • Captions Banner with Real Time Text content. Mocked sendRealTimeText so users can get a similar sending experience in the storybook playground.

Why

How Tested

Process & policy checklist

  • I have updated the project documentation to reflect my changes if necessary.
  • I have read the CONTRIBUTING documentation.

Is this a breaking change?

  • This change causes current functionality to break.

Copy link
Contributor

Failed to pass the UI Test. If this PR is for UI change and the error is snapshot mismatch, please add "update_snapshots" label to the PR for updating the snapshot.


[RealTimeTextModal](./?path=/docs/components-real-time-text-modal--docs) is a component showing a disclaimer warning that real time text is enabled for everyone in the call once turned on. This is important as real time text can not be turned off once it is started.

[StartRealTimeTextButton](./?path=/docs/components-start-real-time-text-button--docs) is a component that can be used to turn on real time text. Note that Real-Time Text will not be started for everyone in the call until a message is sent.
Copy link
Contributor

Choose a reason for hiding this comment

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

how come Real-Time text here is spelt like this here but no where else?

Copy link
Contributor

Choose a reason for hiding this comment

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

  • correction, we use real-time text here and some other places. But we're mixing in a few real time text around. Can we stick to just real-time text

Copy link
Contributor

Copy link
Contributor


<SingleLineBetaBanner />

Azure Communication Services UI Library is adding support for Real-Time Text. Real-Time Text is a powerful tool that enables developers to enhance the accessibility of their videos.
Copy link
Member

Choose a reason for hiding this comment

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

do we want to instead say "Azure Communication Services UI Library supports Real-Time text"

Just thinking this makes sense now as we are just adding it but the text here should read well in 6 months when this is in GA and common use.

@carocao-msft carocao-msft enabled auto-merge (squash) January 29, 2025 22:27
Copy link
Contributor

Failed to pass the UI Test. If this PR is for UI change and the error is snapshot mismatch, please add "update_snapshots" label to the PR for updating the snapshot.

Copy link
Contributor

Calling bundle size is not changed.

  • Current size: 12401100
  • Base size: 12401100
  • Diff size: 0

Copy link
Contributor

CallWithChat bundle size is not changed.

  • Current size: 12401112
  • Base size: 12401112
  • Diff size: 0

Copy link
Contributor

Chat bundle size is decreased✅.

  • Current size: 1776768
  • Base size: 1776770
  • Diff size: -2

Copy link
Contributor

Copy link
Contributor

@azure/communication-react jest test coverage for stable.

Lines Statements Functions Branches
Base 27880 / 44344
62.87%
27880 / 44344
62.87%
783 / 1424
54.98%
2356 / 3720
63.33%
Current 27933 / 44344
62.99%
27933 / 44344
62.99%
783 / 1424
54.98%
2345 / 3716
63.1%
Diff 53 / 0
0.12%
53 / 0
0.12%
0 / 0
0%
-11 / -4
-0.23%

Copy link
Contributor

@azure/communication-react jest test coverage for beta.

Lines Statements Functions Branches
Base 57116 / 94354
60.53%
57116 / 94354
60.53%
1161 / 2687
43.2%
3435 / 5706
60.19%
Current 57118 / 94353
60.53%
57118 / 94353
60.53%
1161 / 2687
43.2%
3448 / 5714
60.34%
Diff 2 / -1
0%
2 / -1
0%
0 / 0
0%
13 / 8
0.15%

@carocao-msft carocao-msft merged commit eb8b42e into main Jan 29, 2025
41 checks passed
@carocao-msft carocao-msft deleted the carocao/Storybook branch January 29, 2025 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants