8000 Fix docs styles when example viewer exceeds the width limit by Ahmed-Hakeem · Pull Request #61384 · angular/angular · GitHub
[go: up one dir, main page]
Skip to content

Fix docs styles when example viewer exceeds the width limit #61384

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Fix docs styles when example viewer exceeds the width limit #61384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3f74df
docs(docs-infra): fix docs pages overflow when specific example-viewe…
Ahmed-Hakeem May 15, 2025
a9cffa9
docs(docs-infra): modify bazel config to include shared docs global s…
Ahmed-Hakeem May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions adev/shared-docs/components/table-of-contents/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ ng_project(
sass_binary(
name = "style",
src = "table-of-contents.component.scss",
deps = [
"//adev/shared-docs/styles",
],
)

ts_project(
Expand Down
8 changes: 5 additions & 3 deletions adev/shared-docs/components/table-of-contents/table-of-contents.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@use '../../styles/media-queries' as mq;

:host {
display: flex;
flex-direction: column;
Expand All @@ -20,7 +22,7 @@
display: none;
}

@media only screen and (max-width: 1430px) {
@include mq.for-large-desktop-down {
position: relative;
right: 0;
max-height: min-content;
Expand Down Expand Up @@ -91,7 +93,7 @@ button {
}
}

@media only screen and (max-width: 1430px) {
@include mq.for-large-desktop-down {
display: none;
}
}
}
12 changes: 9 additions & 3 deletions adev/shared-docs/components/viewers/docs-viewer/docs-viewer.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,28 @@
box-sizing: border-box;
padding-inline: var(--layout-padding);

@media only screen and (max-width: 1430px) {
@include mq.for-large-desktop-down {
container: docs-content / inline-size;
}

@include mq.for-big-desktop-up {
@include mq.for-extra-large-desktop-up {
max-width: var(--page-width);
}


//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up {
// take the available space except a reserved area for TOC
margin-left: -16rem;
width: calc(100% - 16rem);
}

// restrict the content to be fluid until it reaches that width
// $screen-xl is the breakpoint where Main content stop being fluid and made fixed

>*:not(docs-table-of-contents) {
max-width: calc(mq.$screen-xxl - var(--secondary-nav-width) - var(--primary-nav-width) - var(--layout-padding)*2)
}

pre {
margin-block: 0;
Expand Down
21 changes: 17 additions & 4 deletions adev/shared-docs/styles/_media-queries.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ $screen-xs: 700px;
$screen-sm: 775px;
$screen-md: 900px;
$screen-lg: 1200px;
$screen-xl: 1800px;
$screen-xl: 1430px;
$screen-xxl: 1800px;

@mixin for-phone-only {
@media (max-width: $screen-xs) {
Expand Down Expand Up @@ -40,8 +41,14 @@ $screen-xl: 1800px;
}
}

@mixin for-big-desktop-up {
@media (min-width: calc($screen-xl + 1px)) {
@mixin for-large-desktop-up {
@media (min-width: calc($screen-xl + .01px)) {
@content;
}
}

@mixin for-extra-large-desktop-up {
@media (min-width: calc($screen-xxl + 1px)) {
@content;
}
}
Expand All @@ -52,6 +59,12 @@ $screen-xl: 1800px;
}
}

@mixin for-large-desktop-down {
@media (max-width: calc($screen-xl )) {
@content;
}
}

@mixin for-tablet-landscape-down {
@media (max-width: $screen-md) {
@content;
Expand All @@ -62,4 +75,4 @@ $screen-xl: 1800px;
@media (max-width: $screen-sm) {
@content;
}
}
}
2 changes: 1 addition & 1 deletion adev/shared-docs/styles/_resets.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
'Segoe UI Symbol', 'Noto Color Emoji';
--page-width: 80ch;
--layout-padding: 3.12rem; // a common padding value throughout the layout
--primary-nav-width: 110px;
--primary-nav-width: 6.875rem;
--secondary-nav-width: 16.25rem;
--fixed-content-height: calc(100vh - var(--layout-padding) * 2);

Expand Down
20 changes: 9 additions & 11 deletions adev/shared-docs/styles/global-styles.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,17 @@
@include mq.for-tablet-portrait-up();
@include mq.for-tablet-landscape-up();
@include mq.for-desktop-up();
@include mq.for-big-desktop-up();
@include mq.for-extra-large-desktop-up();
@include mq.for-tablet-landscape-down();

// temporary just to show different options of code component UI.
$primary: mat.m2-define-palette(mat.$m2-indigo-palette);
$accent: mat.m2-define-palette(mat.$m2-pink-palette, A200, A100, A400);
$theme: mat.m2-define-light-theme(
(
color: (
primary: $primary,
accent: $accent,
),
typography: mat.m2-define-typography-config(),
)
);
$theme: mat.m2-define-light-theme((color: (primary: $primary,
accent: $accent,
),
typography: mat.m2-define-typography-config(),
));

// Include material core styles.
@include cdk.a11y-visually-hidden();
Expand All @@ -85,6 +81,7 @@ $theme: mat.m2-define-light-theme(

// Disable view transitions when reduced motion is requested.
@media (prefers-reduced-motion) {

::view-transition-group(*),
::view-transition-old(*),
::view-transition-new(*) {
Expand Down Expand Up @@ -121,6 +118,7 @@ $theme: mat.m2-define-light-theme(

a {
color: inherit;

&:hover {
text-decoration: underline;
}
Expand All @@ -146,4 +144,4 @@ $theme: mat.m2-define-light-theme(
background-color: inherit;
}
}
}
}
6 changes: 4 additions & 2 deletions adev/src/app/core/layout/footer/footer.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@use '@angular/docs/styles/media-queries' as mq;

.adev-footer-columns {
display: grid;
grid-template-columns: repeat(4, 1fr);
Expand All @@ -18,8 +20,8 @@
transition: background-color 0.3s ease;

// this accounts for absolutely positioned TOC on the right
@media only screen and (min-width: 1430px) {
width: calc(100% - 195px - var(--layout-padding) * 3);
@include mq.for-large-desktop-up{
width: calc(100% - 195px - var(--layout-padding) * 3);
}

h2 {
Expand Down
4 changes: 3 additions & 1 deletion adev/src/app/features/docs/docs.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@use '@angular/docs/styles/media-queries' as mq;

:host {
display: block;
padding-top: var(--layout-padding);
Expand All @@ -10,7 +12,7 @@
}

//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up{
display: flex;
justify-content: center;
}
Expand Down
16 changes: 7 additions & 9 deletions adev/src/app/features/home/components/home-animation/home-animation.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ $transition: 200ms linear;
}
}

@include mq.for-big-desktop-up {
@include mq.for-extra-large-desktop-up {
& {
transform: scale(0.5);
}
Expand Down Expand Up @@ -331,12 +331,10 @@ $transition: 200ms linear;
}

@mixin meteor-gradient($startColor, $endColor) {
background: linear-gradient(
calc(var(--math-pi) + var(--meteor-tilt-angle)),
$startColor 0,
$endColor 66%,
transparent 100%
);
background: linear-gradient(calc(var(--math-pi) + var(--meteor-tilt-angle)),
$startColor 0,
$endColor 66%,
transparent 100%);
}

&.type-1::after {
Expand Down Expand Up @@ -391,9 +389,9 @@ $transition: 200ms linear;
transform: scale(1);
}

.build-for-everyone-layer > .title {
.build-for-everyone-layer>.title {
background-position-x: 0;
}
}
}
}
}
6 changes: 3 additions & 3 deletions .../features/references/api-reference-details-page/api-reference-details-page.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@


//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up {
// take the available space except a reserved area for TOC
width: calc(100% - 16rem);
}
Expand All @@ -23,7 +23,7 @@
width: 100%;

//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up {
// take the available space except a reserved area for TOC
max-width: var(--page-width);
}
Expand All @@ -39,7 +39,7 @@
&>* {
padding-inline: 0px;

@include mq.for-big-desktop-up {
@include mq.for-extra-large-desktop-up {
width: var(--page-width);
}
}
Expand Down
4 changes: 2 additions & 2 deletions .../features/references/cli-reference-details-page/cli-reference-details-page.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@


//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up{
// take the available space except a reserved area for TOC
width: calc(100% - 16rem);
}
Expand All @@ -24,7 +24,7 @@
width: 100%;

//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up{
// take the available space except a reserved area for TOC
max-width: var(--page-width);
}
Expand Down
4 changes: 2 additions & 2 deletions adev/src/app/features/tutorial/tutorial.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ $column-width: calc(50% - #{$resizer-width} - var(--layout-padding));
.docs-viewer {

//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up {
// take the available space except a reserved area for TOC
margin-left: 0rem;
width: unset;
Expand Down Expand Up @@ -148,7 +148,7 @@ $column-width: calc(50% - #{$resizer-width} - var(--layout-padding));
.adev-split-tutorial {
width: 50%;

@include mq.for-big-desktop-up {
@include mq.for-extra-large-desktop-up {
width: 100%;
}

Expand Down
4 changes: 2 additions & 2 deletions adev/src/app/features/update/update.component.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
padding-inline: var(--layout-padding);

//applying styles when TOC position got translated to the top right
@media only screen and (min-width: 1431px) {
@include mq.for-large-desktop-up {
// take the available space except a reserved area for TOC
margin-left: -16rem;
width: calc(100% - 16rem);
Expand All @@ -28,7 +28,7 @@
max-width: var(--page-width);

&>* {
@include mq.for-big-desktop-up {
@include mq.for-extra-large-desktop-up {
padding-inline: 0px;
}
}
Expand Down
0