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

Add minimal prop to Callout which hides the background fill color #6952

Merged
merged 5 commits into from
Aug 27, 2024

Conversation

ayxliu19
Copy link
Contributor

@ayxliu19 ayxliu19 commented Aug 27, 2024

Checklist

  • Includes tests
  • Update documentation

Changes proposed in this pull request:

New minimal prop on the Callout component that hides the background fill color

Screenshot 2024-08-27 at 2 34 50 PM

Reviewers should focus on:

  1. Go to http://localhost:9001/#core/components/callout
  2. Toggle the minimal option and observe that the background color turns on and off.

@changelog-app
Copy link

changelog-app bot commented Aug 27, 2024

Generate changelog in packages/core/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add minimal prop to Callout which hides the background fill color


Generate changelog in packages/docs-app/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add minimal prop to Callout which hides the background fill color


Check the box to generate changelog(s)

  • Generate changelog entry

@svc-palantir-github
Copy link

Add generated changelog entries

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

&.#{$ns}-minimal.#{$ns}-intent-danger {
background-color: transparent;
}

.#{$ns}-dark & {
background-color: rgba($gray3, 0.2);
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like we're missing overrides for the dark mode variants of Callout.

Screenshot 2024-08-27 at 15 03 26

&.#{$ns}-minimal.#{$ns}-intent-warning,
&.#{$ns}-minimal.#{$ns}-intent-danger {
background-color: transparent;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of explicitly overwriting styles, could we instead use a negation pseudo-class to prevent the background color from being applied in the first case if the callout is minimal? e.g.

.#{$ns}-callout {
  &:not(.#{$ns}-minimal) {
    background-color: rgba($gray3, 0.15);
  }

  .#{$ns}-dark & {
    &:not(.#{$ns}-minimal) {
      background-color: rgba($gray3, 0.2);
    }
  }

  @each $intent, $color in $pt-intent-colors {
    &.#{$ns}-intent-#{$intent} {
      &:not(.#{$ns}-minimal) {
        background-color: rgba($color, 0.1);
      }

      .#{$ns}-dark & {
        &:not(.#{$ns}-minimal) {
          background-color: rgba($color, 0.2);
        }
      }
    }
  }
}

@svc-palantir-github
Copy link

Address comments

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

ggdouglas
ggdouglas previously approved these changes Aug 27, 2024
Copy link
Contributor

@ggdouglas ggdouglas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@policy-bot policy-bot bot dismissed ggdouglas’s stale review August 27, 2024 20:16

Invalidated by push of 79ce206

@svc-palantir-github
Copy link

lint

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

@ayxliu19 ayxliu19 merged commit dc1b162 into develop Aug 27, 2024
13 checks passed
@ayxliu19 ayxliu19 deleted the al/minimal-callout branch August 27, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants