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

feat: vica integration #982

Merged
merged 5 commits into from
Jan 14, 2025
Merged

feat: vica integration #982

merged 5 commits into from
Jan 14, 2025

Conversation

adriangohjw
Copy link
Contributor

@adriangohjw adriangohjw commented Jan 13, 2025

Problem

Add integration for VICA

Solution

Breaking Changes

  • Yes - this PR contains breaking changes
    • Details ...
  • No - this PR is backwards compatible

Features:

Refer to this slack message for installation guide: https://opengovproducts.slack.com/archives/C087MUEJAMA/p1736330772752669?thread_ts=1736245461.677389&cid=C087MUEJAMA

note: decided to follow vica's way of specifying the keys and values as will be easier to port over from agency

  • Add Vica stylesheet and widget component
  • Add vica props to siteprops
  • todo - clarifying with VICA on usage of props to pass in colour config (installation guide wasn't clear). In the meantime, we can manually pass it in via the props

Tests

note: slightly tricky to test as we will need to get the app-id and app-name from agencies

  1. add the necessary vica config in site in the Site table
  2. rebuild and see if it shows up

@adriangohjw adriangohjw added the enhancement New feature or request label Jan 13, 2025
@adriangohjw adriangohjw self-assigned this Jan 13, 2025
@adriangohjw adriangohjw requested a review from a team as a code owner January 13, 2025 06:13
@datadog-opengovsg
Copy link

datadog-opengovsg bot commented Jan 13, 2025

Datadog Report

Branch report: vica-integration
Commit report: b8194b0
Test service: isomer-studio

✅ 0 Failed, 257 Passed, 36 Skipped, 46.82s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link
Contributor

@seaerchin seaerchin left a comment

Choose a reason for hiding this comment

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

mostly lgtm - i just took a (brief) look at the vica docs linked in slack

Comment on lines +3 to +6
// NOTE: not all props will be used even if we passed them in
// as we will override some of them with Isomer's configuration e.g. font-family
// Nevertheless, keeping them here for reference
interface VicaWidgetProps {
Copy link
Contributor

Choose a reason for hiding this comment

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

abit confused - how will we override? i'm assuming the compiled css will have font-family but how will vica pick it up

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can override directly in

<div
id="webchat"
{...props}
app-font-family="Inter, system-ui, sans-serif"
// NOTE: Clarifying with VICA regarding color scheme
// Once confirmed, will override with site's color scheme for consistency
/>

once VICA got back to me, we also ideally want to use the site's color to prefill this. For now the only props we know we will override what's passed in is font family

@adriangohjw adriangohjw merged commit 8804e72 into main Jan 14, 2025
17 of 20 checks passed
@adriangohjw adriangohjw deleted the vica-integration branch January 14, 2025 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants