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

chore(docs): added callouts for documentation pages (#DS-2547) #433

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions apps/docs/src/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

@use './styles/markdown';
@use './styles/docsearch';
@use './styles/callout';

.docs {
@include theme-kbq.docs-typography();
Expand Down
127 changes: 127 additions & 0 deletions apps/docs/src/styles/_callout.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
/* stylelint-disable scss/at-extend-no-missing-placeholder */

/**
Usage:

```html
<div class="kbq-callout kbq-callout_theme">
<div class="kbq-callout__header">...</div>
<div class="kbq-callout__content">...</div>
</div>
```
*/

@use '@koobiq/icons/fonts/kbq-icons';

%kbq-callout_contrast {
border-color: var(--kbq-line-contrast-less);
background-color: var(--kbq-background-bg-secondary);

.kbq-callout__header {
color: var(--kbq-foreground-contrast-secondary);

&::before {
@extend .kbq;
@extend .kbq-question-circle_16;
}
}

.kbq-callout__content {
color: var(--kbq-foreground-contrast);
background-color: var(--kbq-background-bg);
}
}

.kbq-callout {
overflow: hidden;
border-width: 2px;
border-style: solid;
border-radius: var(--kbq-size-s);
margin-bottom: var(--kbq-size-xl);

.kbq-callout__header {
display: flex;
align-items: center;
gap: var(--kbq-size-s);
font-size: var(--kbq-md-typography-md-h5-font-size);
font-weight: var(--kbq-typography-text-normal-strong-font-weight);
line-height: var(--kbq-typography-text-normal-strong-line-height);
letter-spacing: var(--kbq-typography-text-normal-strong-letter-spacing);
}

.kbq-callout__content {
font-size: var(--kbq-md-typography-md-body-font-size);
font-weight: var(--kbq-md-typography-md-body-font-weight);
line-height: var(--kbq-md-typography-md-body-line-height);
letter-spacing: var(--kbq-md-typography-md-body-letter-spacing);
Comment on lines +53 to +56
Copy link
Contributor

Choose a reason for hiding this comment

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

Если стили типографики раздела полностью совпадают с определенным шрифтом, то можно его напрямую использовать

Suggested change
font-size: var(--kbq-md-typography-md-body-font-size);
font-weight: var(--kbq-md-typography-md-body-font-weight);
line-height: var(--kbq-md-typography-md-body-line-height);
letter-spacing: var(--kbq-md-typography-md-body-letter-spacing);
@extend .md-body;

border-radius: var(--kbq-size-s) var(--kbq-size-s) 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

команда UX завела глобальный токен border-radius, у него такое же значение, но он больше подходит для описания бордер радиуса

Suggested change
border-radius: var(--kbq-size-s) var(--kbq-size-s) 0;
border-radius: var(--kbq-size-border-radius) var(--kbq-size-border-radius) 0;

}

.kbq-callout__header,
.kbq-callout__content {
padding: var(--kbq-size-s) var(--kbq-size-l);
}

// setup contrast theme by default
@extend %kbq-callout_contrast;

&.kbq-callout_contrast {
@extend %kbq-callout_contrast;
}

&.kbq-callout_theme {
border-color: var(--kbq-line-theme);
background-color: var(--kbq-background-theme-fade);

.kbq-callout__header {
color: var(--kbq-foreground-theme);

&::before {
@extend .kbq;
@extend .kbq-exclamation-circle_16;
}
}
}

&.kbq-callout_success {
border-color: var(--kbq-line-success);
background-color: var(--kbq-background-success-fade);

.kbq-callout__header {
color: var(--kbq-foreground-success);

&::before {
@extend .kbq;
@extend .kbq-check-circle_16;
}
}
}

&.kbq-callout_warning {
border-color: var(--kbq-line-warning);
background-color: var(--kbq-background-warning-fade);

.kbq-callout__header {
color: var(--kbq-foreground-warning);

&::before {
@extend .kbq;
@extend .kbq-exclamation-triangle_16;
}
}
}

&.kbq-callout_error {
border-color: var(--kbq-line-error);
background-color: var(--kbq-background-error-fade);

.kbq-callout__header {
color: var(--kbq-foreground-error);

&::before {
@extend .kbq;
@extend .kbq-minus-circle_16;
}
}
}
}
1 change: 0 additions & 1 deletion apps/docs/src/styles/_docsearch.scss
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/* stylelint-disable scss/at-extend-no-missing-placeholder */

@use '@docsearch/css/dist/style';
@use 'koobiq/default-theme/variables' as *;
@use '@koobiq/icons/fonts/kbq-icons';

.DocSearch-Button {
Expand Down
9 changes: 8 additions & 1 deletion docs/guides/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,14 @@ this.colorAutomaticTheme.addEventListener('change', this.setAutoTheme);
**Компонентные CSS-переменные** – это набор значений, которые используются в стилях наших компонентов. Они задаются на основе токенов и хранятся в репозитории `@koobiq/components`.
Это позволяет нам легко использовать токены в стилях компонентов и ускоряет разработку, в том числе проведение дизайн-ревью.

**Обрати внимание!** На данный момент компонентные токены в пакете `@koobiq/design-tokens` больше не обновляются.
<div class="kbq-callout kbq-callout_warning">
<div class="kbq-callout__header">Обрати внимание</div>
<div class="kbq-callout__content">

На данный момент компонентные токены в пакете `@koobiq/design-tokens` больше не обновляются.

</div>
</div>

### Планы

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
**Обрати внимание!** Этот компонент является экспериментальным, он обратно совместим с оригинальным компонентом, но его не рекомендуется использовать в продакшн-приложениях.
<div class="kbq-callout kbq-callout_warning">
<div class="kbq-callout__header">Обрати внимание</div>
<div class="kbq-callout__content">

Этот компонент является экспериментальным, он обратно совместим с оригинальным компонентом, но его не рекомендуется использовать в продакшн-приложениях.

</div>
</div>

Основные изменения:

Expand Down
10 changes: 8 additions & 2 deletions packages/components/core/validation/validation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
**Обрати внимание!** К элементам формы применяется [`KbqValidateDirective`](https://github.com/koobiq/angular-components/blob/main/packages/components/form-field/validate.directive.ts),
которая подменяет методы формы (`Validators`, `onSubmit`), что может привести к _"непредсказуемому"_ поведению.
<div class="kbq-callout kbq-callout_warning">
<div class="kbq-callout__header">Обрати внимание</div>
<div class="kbq-callout__content">

К элементам формы применяется [`KbqValidateDirective`](https://github.com/koobiq/angular-components/blob/main/packages/components/form-field/validate.directive.ts), которая подменяет методы формы (`Validators`, `onSubmit`), что может привести к _"непредсказуемому"_ поведению.

</div>
</div>

### Отключение KbqValidateDirective

Expand Down
11 changes: 9 additions & 2 deletions packages/components/markdown/markdown.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
`kbq-markdown` - компонент, который позволяет преобразовывать текст, написанный на языке разметки `Markdown`, в `HTML`.
`kbq-markdown` - компонент, который позволяет преобразовывать текст, написанный на языке разметки _Markdown_, в _HTML_.

**Обрати внимание!** Для работы компонента, необходимо наличие [`marked`](https://github.com/markedjs/marked) зависимости:
<div class="kbq-callout kbq-callout_warning">
<div class="kbq-callout__header">Обрати внимание</div>
<div class="kbq-callout__content">

Для работы компонента, необходимо наличие [`marked@^9`](https://github.com/markedjs/marked/tree/v9.1.6) зависимости:

```bash
npm install marked@^9
```

</div>
</div>

### Заголовки

<!-- example(markdown-headers) -->
Expand Down
14 changes: 10 additions & 4 deletions packages/components/scrollbar/scrollbar.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
`<kbq-scrollbar>` - это компонент (обертка над библиотекой [`overlayscrollbars`](https://github.com/KingSora/OverlayScrollbars)),
который используется для настройки параметров скроллбара.
`<kbq-scrollbar>` - это компонент который используется для настройки параметров скроллбара.

**Обрати внимание!** Для работы компонента, необходимо наличие `[email protected]` зависимости, установи её при отсутствии:
<div class="kbq-callout kbq-callout_warning">
<div class="kbq-callout__header">Обрати внимание</div>
<div class="kbq-callout__content">

```
Для работы компонента, необходимо наличие [`[email protected]`](https://github.com/KingSora/OverlayScrollbars/tree/v2.7.0) зависимости:

```bash
npm install [email protected]
```

</div>
</div>

## Настройка и передача параметров:

- для определенного скроллбара, при помощи атрибута `options`:
Expand Down
Loading