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(internet-header): expose CSS custom properties #3200

Merged
merged 5 commits into from
Jul 11, 2024

Conversation

alizedebray
Copy link
Contributor

No description provided.

@alizedebray alizedebray linked an issue Jul 1, 2024 that may be closed by this pull request
Copy link

changeset-bot bot commented Jul 1, 2024

🦋 Changeset detected

Latest commit: bd68e7b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@swisspost/internet-header Minor
@swisspost/design-system-documentation Minor
@swisspost/design-system-nextjs-integration Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@swisspost-bot
Copy link
Contributor

swisspost-bot commented Jul 1, 2024

Related Previews

Copy link
Member

@gfellerph gfellerph left a comment

Choose a reason for hiding this comment

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

@alizedebray I think this is the way to go. Are the global styles delivered via JS or do the projects have to import an additional CSS file?

@alizedebray
Copy link
Contributor Author

alizedebray commented Jul 1, 2024

@alizedebray I think this is the way to go. Are the global styles delivered via JS or do the projects have to import an additional CSS file?

@gfellerph global styles have to be added manually by the consumers. This is why I declared the variables both on the :root and on the :host, this way you only have to import the global styles if you need to use the custom variables. What do you think?

The main drawback with this approach (apart from duplication) is that is makes the header height customizable... Otherwise we could expose the SCSS variables but then it is no longer framework agnostic.

@alizedebray alizedebray force-pushed the 3194-internet-header-expose-css-custom-properties branch from bc9a05a to a03c6be Compare July 1, 2024 14:52
@alizedebray alizedebray self-assigned this Jul 2, 2024
@gfellerph
Copy link
Member

@gfellerph global styles have to be added manually by the consumers. This is why I declared the variables both on the :root and on the :host, this way you only have to import the global styles if you need to use the custom variables. What do you think?

That's perfect. Can you please add documentation how to do that?

The main drawback with this approach (apart from duplication) is that is makes the header height customizable... Otherwise we could expose the SCSS variables but then it is no longer framework agnostic.

I think that's negligible. If you want to break the header, there are a thousand ways to do so. Setting this variable by mistake is an easy fix.

@alizedebray alizedebray marked this pull request as ready for review July 2, 2024 10:59
@alizedebray alizedebray requested a review from a team as a code owner July 2, 2024 10:59
@alizedebray
Copy link
Contributor Author

alizedebray commented Jul 2, 2024

Can you please add documentation how to do that?

@gfellerph Sure, I added the documentation this morning: https://preview-3200--swisspost-design-system-next.netlify.app/?path=/docs/bfdf4e7c-37d3-40f8-a5d0-734f3e6612b5--docs

Copy link
Member

@gfellerph gfellerph left a comment

Choose a reason for hiding this comment

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

Good work!

.changeset/flat-gifts-report.md Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Jul 11, 2024

@alizedebray alizedebray merged commit cf081ce into main Jul 11, 2024
9 checks passed
@alizedebray alizedebray deleted the 3194-internet-header-expose-css-custom-properties branch July 11, 2024 09:37
gfellerph pushed a commit that referenced this pull request Jul 18, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @swisspost/[email protected]

### Minor Changes

- Added an invalid message for the card-control component and an icon in
the invalid message of the checkbox and radio button (by
[@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#2978](#2978))

- Added a `delayed` property to the `post-tooltip` component to allow
delaying its display for a few milliseconds after it is triggered. (by
[@alizedebray](https://github.com/alizedebray) with
[#3245](#3245))

- Added a `post-collapsible-trigger` component to properly handle the
role, ARIA attributes, and event listeners for elements that toggle a
`post-collapsible`. (by [@alizedebray](https://github.com/alizedebray)
with [#3209](#3209))

### Patch Changes

- Fixed an issue with popovers on Firefox ESR that unexpectedly closed
popovers when clicking on content. (by
[@gfellerph](https://github.com/gfellerph) with
[#3211](#3211))

- Prevent the `post-tabs` component from triggering a `post Change`
event before it is loaded. (by
[@alizedebray](https://github.com/alizedebray) with
[#3247](#3247))

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added a `post-collapsible-trigger` component to properly handle the
role, ARIA attributes, and event listeners for elements that toggle a
`post-collapsible`. (by [@alizedebray](https://github.com/alizedebray)
with [#3209](#3209))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added icons number 2592, 2593, 2594 and 2595. (by
[@swisspost-bot](https://github.com/swisspost-bot) with
[#3264](#3264))

## @swisspost/[email protected]

### Minor Changes

- Added a new stylesheet containing `:root` CSS custom properties to
facilitate implementing styles relative to the header. This will allow
putting sticky content right below the header. (by
[@alizedebray](https://github.com/alizedebray) with
[#3200](#3200))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added an invalid message for the card-control component and an icon in
the invalid message of the checkbox and radio button (by
[@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#2978](#2978))

- Pre-compiled CSS files are now shipped with the package to enable
projects not using Sass to selectively import component styles. (by
[@gfellerph](https://github.com/gfellerph) with
[#3283](#3283))

### Patch Changes

- Fixed visual issues with validated form-elements who receive focus.
(by [@oliverschuerch](https://github.com/oliverschuerch) with
[#3166](#3166))

- Updated buttons colors. (by [@imagoiq](https://github.com/imagoiq)
with [#2977](#2977))

- Updated table colors on dark backgrounds. (by
[@alizedebray](https://github.com/alizedebray) with
[#2718](#2718))

- Switched from light to regular font weight for most texts, excluding
sub-titles. (by [@oliverschuerch](https://github.com/oliverschuerch)
with [#3284](#3284))

## @swisspost/[email protected]

### Minor Changes

- Created a Swiss Post Design System theme for PrimeNg datatable. (by
[@alizedebray](https://github.com/alizedebray) with
[#2718](#2718))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]



## @swisspost/[email protected]

### Major Changes

- Created a workspace to maintain the Swiss Post PrimeNg theme. (by
[@alizedebray](https://github.com/alizedebray) with
[#2718](#2718))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added a `post-collapsible-trigger` component to properly handle the
role, ARIA attributes, and event listeners for elements that toggle a
`post-collapsible`. (by [@alizedebray](https://github.com/alizedebray)
with [#3209](#3209))

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Minor Changes

- Added a new stylesheet containing `:root` CSS custom properties to
facilitate implementing styles relative to the header. This will allow
putting sticky content right below the header. (by
[@alizedebray](https://github.com/alizedebray) with
[#3200](#3200))

- Added the compatibility table entries for v7. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#3294](#3294))

- Added a `delayed` property to the `post-tooltip` component to allow
delaying its display for a few milliseconds after it is triggered. (by
[@alizedebray](https://github.com/alizedebray) with
[#3245](#3245))

- Added documentation on how to get started with the
`@swisspost/design-system-styles-primeng` package. (by
[@alizedebray](https://github.com/alizedebray) with
[#2718](#2718))

- Added a `post-collapsible-trigger` component to properly handle the
role, ARIA attributes, and event listeners for elements that toggle a
`post-collapsible`. (by [@alizedebray](https://github.com/alizedebray)
with [#3209](#3209))

### Patch Changes

- Fixed the documentation heading links by adding the rehype-slug plugin
(by [@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#3279](#3279))

- Deprecated accent colors. (by
[@davidritter-dotcom](https://github.com/davidritter-dotcom) with
[#3195](#3195))

- Updated tabs to improve visual continuity and readability. (by
[@alizedebray](https://github.com/alizedebray) with
[#3254](#3254))

- Fixed the wrong implementation of the intranet-header changeset.md
file in the changelog/intranet-header docs page. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#3293](#3293))

- Fix headers for the `versions.json` file. So it can be loaded and used
from the version-switcher of older documentation pages. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#3267](#3267))

- Removed horizontal scrollbar showing up in Firefox, when a docs
specific tab component is present on the page. (by
[@oliverschuerch](https://github.com/oliverschuerch) with
[#3268](#3268))

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]

## @swisspost/[email protected]

### Patch Changes

-   Updated dependencies:
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]
    -   @swisspost/[email protected]

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.

Internet Header: Expose CSS custom properties
3 participants