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 ef3_edit-form-components page #166

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pepelyaeva
Copy link
Contributor

@pepelyaeva pepelyaeva commented Apr 18, 2023

Summary by CodeRabbit

  • Новые функции

    • Добавлена новая конфигурация test_stand_3x_url для документации.
    • В боковом меню документации добавлен новый элемент "Компоненты для работы с данными на форме редактирования".
  • Изменения в стилях

    • Обновлены стили заголовков и кнопок для улучшения визуального восприятия.
    • Добавлены эффекты наведения для социальных иконок.
  • Документация

    • Добавлена документация для компонентов, используемых в рамках Flexberry Ember, включая примеры использования и описание свойств.

`placeholder` | Определяет placeholder.
`label` | Определяет заголовок поля.
`classNames` | Определяет css-class на компонент.
`type` | Определяет вид компонента.
Copy link
Contributor

Choose a reason for hiding this comment

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

Интересен список доступных вариантов, что в type можно записать.

`classNames` | Определяет css-class на компонент.
`type` | Определяет вид компонента.
`maxlength` | Определяет максимальное количество символов (в единицах кода UTF-16), которое может ввести пользователь.
`appConfigSettingsPath` | Определяет путь к настройкам компонента в конфигурации приложения.
Copy link
Contributor

Choose a reason for hiding this comment

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

Мне как пользователю был бы интересен пример, что в appConfigSettingsPath стоит писать.

`classNames` | Определяет css-class на компонент.
`defaultMinute` | Определяет значение минут по умолчанию.
`defaultHour` | Определяет значение часов по умолчанию.
`useBrowserInput` | Флаг, определяющий нужно ли использовать импут браузера
Copy link
Contributor

Choose a reason for hiding this comment

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

Опечатка импут

`classNames` | Определяет css-class на компонент.
`appConfigSettingsPath` | Определяет путь к настройкам компонента в конфигурации приложения.
`rows` | Определяет количество строк таблицы, связанных с текстовой областью.
`cols` | Определяет количество столбцов таблицы, связанных с текстовой областью.
Copy link
Contributor

Choose a reason for hiding this comment

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

Непонятно, о какой таблице идёт речь.


### flexberry-simpledatetime

`flexberry-simpledatetime` - компонент для отображения даты/даты и времени.
Copy link
Contributor

Choose a reason for hiding this comment

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

Очень странно выглядит формулировка, если честно.

`classNames` | Определяет css-class на компонент.
`defaultMinute` | Определяет значение минут по умолчанию.
`defaultHour` | Определяет значение часов по умолчанию.
`useBrowserInput` | Флаг, определяющий нужно ли использовать импут браузера
Copy link
Contributor

Choose a reason for hiding this comment

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

Пропущена запятая "определяющий, нужно".

`min` | Определяет самую раннюю дату, которую пользователь может выбрать.
`max` | Определяет самую последнюю дату, которую пользователь может выбрать.
`type` | Определяет вид компонента.
`canClick` | Флаг, определяющий нужно ли onClick вызывать flatpickr.open()
Copy link
Contributor

Choose a reason for hiding this comment

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

Пропущена запятая "определяющий, нужно".

`min` | Определяет самую раннюю дату, которую пользователь может выбрать.
`max` | Определяет самую последнюю дату, которую пользователь может выбрать.
`type` | Определяет вид компонента.
`canClick` | Флаг, определяющий нужно ли onClick вызывать flatpickr.open()
Copy link
Contributor

Choose a reason for hiding this comment

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

Непонятно, что за flatpickr и что с ним делать.


### flexberry-ddau-checkbox

`flexberry-ddau-checkbox` - компонент для отображения логических данных.
Copy link
Contributor

Choose a reason for hiding this comment

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

Может сразу указать, чем он принципиально отличается от flexberry-checkbox?

Свойства `componentName` и `readonly` | Свойства из [базового контрола](ef2_base-component.html).
`value` | Определяет значение, которое будет отображаться.
`class` | Определяет css-class на компонент.
`items` | Определяет перечисление.
Copy link
Contributor

Choose a reason for hiding this comment

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

Не очень понятно написано.

class="save-button"
disabled=(readonly)
text=(t "forms.edit-form.save-button-text")
action="save")
Copy link
Contributor

Choose a reason for hiding this comment

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

А про структуру
(hash
type="submit"
class="save-button"
disabled=(readonly)
text=(t "forms.edit-form.save-button-text")
action="save")

будет в документации?

Свойство | Краткое описание
:--------|:----------------
`showCloseButton` | Определяет, показывать ли кнопку Закрыть в тулбаре. По умолчанию данное свойство имеет значение `false`.
`deepMount` | Определяет вычитку действий кнопок. По умолчанию данное свойство имеет значение `false`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Непонятно.

Свойство | Краткое описание
:--------|:----------------
`readonly` | Определяет, доступен ли объект только для чтения. По умолчанию данное свойство имеет значение `false`.
`classNames` | Определяет css-class на компонент.
Copy link
Contributor

Choose a reason for hiding this comment

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

Опечатка? "Определяет css-class компонента."?

`readonly` | Определяет, доступен ли объект только для чтения. По умолчанию данное свойство имеет значение `false`.
`classNames` | Определяет css-class на компонент.
`value` | Определяет значение, которое будет отображаться.
`min` | Определяет минимальное значение компонента.
Copy link
Contributor

Choose a reason for hiding this comment

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

В каких единицах указывать? Это натуральное число или дроби можно?

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

В данном пулл-реквесте внесены изменения в несколько файлов конфигурации и стилей для проекта Flexberry Ember. В файл _config.yml добавлен новый параметр test_stand_3x_url, указывающий на URL тестового стенда. В файл боковой панели _data/sidebars/flexberry-ember-3_sidebar.yml добавлен новый элемент, относящийся к компонентам форм редактирования. Также изменены стили в файлах css/customstyles.css и css/theme-flexberry.css, включая изменения отступов, цветов и эффектов при наведении. Наконец, добавлен новый файл документации ef3_edit-form-components.ru.md, описывающий компоненты для работы с данными на формах редактирования.

Changes

Файл Изменения
_config.yml Добавлен параметр test_stand_3x_url: 'http://flexberry.github.io/ember-flexberry/dummy/dummy-test-2'
_data/sidebars/flexberry-ember-3_sidebar.yml Добавлен элемент: Components for edit-forms (Русский: Компоненты для работы с данными на форме редактирования), URL: /ef3_edit-form-components.html, форматы: web, pdf
css/customstyles.css Изменены отступы и цвета для заголовков, добавлены эффекты при наведении для иконок социальных сетей.
css/theme-flexberry.css Изменены стили для элементов h4, .item-head, .btn-primary, добавлен класс .webinar, изменены медиа-запросы.
pages/products/flexberry-ember/3.x/components/ef3_edit-form-components.ru.md Добавлена документация для компонентов: flexberry-field, flexberry-textbox, flexberry-textarea, flexberry-simpledatetime, flexberry-checkbox, flexberry-ddau-checkbox, flexberry-dropdown, flexberry-jsonarea, flexberry-edit-panel, flexberry-button, flexberry-ddau-slider, flexberry-colorpicker.

Poem

В лесу, где зайцы скачут,
Новые изменения нас радуют,
Ссылки и стили, как в сказке,
Теперь всё ярче, всё в порядке!
Компоненты в документации ждут,
Зайцы с радостью их изучат, вот! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (5)
pages/products/flexberry-ember/3.x/components/ef3_edit-form-components.ru.md (5)

42-44: Необходимо дополнить документацию примерами.

В свойствах type и appConfigSettingsPath не указаны возможные значения и примеры использования, что затрудняет понимание их применения.

Предлагаю добавить:

  1. Список допустимых значений для свойства type
  2. Пример конфигурации для appConfigSettingsPath

111-112: Требуется уточнение описания свойств rows и cols.

Текущее описание свойств rows и cols не дает четкого понимания их влияния на компонент. Необходимо пояснить, что это свойства определяют начальные размеры текстовой области.

Предлагаю изменить описания на:

  • rows | Определяет начальную высоту текстовой области в строках
  • cols | Определяет начальную ширину текстовой области в символах

151-151: Дополнить документацию описанием flatpickr.

Свойство canClick ссылается на flatpickr, но нигде не объясняется, что это такое.

Предлагаю добавить краткое описание библиотеки flatpickr в начало раздела компонента, например:
"Компонент использует библиотеку flatpickr для отображения календаря и выбора даты/времени."


189-189: Уточнить отличия от flexberry-checkbox.

Компонент flexberry-ddau-checkbox описан как аналог flexberry-checkbox, но не указаны его особенности.

Предлагаю дополнить описание информацией об основных отличиях, например:
"Компонент реализует подход Data Down Actions Up (DDAU) и позволяет явно обрабатывать изменения значения через action."


385-385: Уточнить формат значений для свойств min и max.

Не указано, в каких единицах измерения задаются значения и какие типы значений поддерживаются.

Предлагаю дополнить описание свойств информацией о допустимых значениях и формате, например:

  • min | Определяет минимальное числовое значение компонента (целое или дробное число)
  • max | Определяет максимальное числовое значение компонента (целое или дробное число)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 739633d and 614a84c.

⛔ Files ignored due to path filters (11)
  • images/favicon.ico is excluded by !**/*.ico
  • images/pages/products/flexberry-ember/3.x/components/flexberry-button.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-checkbox.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-ddau-slider.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-dropdown.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-edit-panel.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-field.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-jsonarea.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-simpledatetime.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-textarea.png is excluded by !**/*.png
  • images/pages/products/flexberry-ember/3.x/components/flexberry-textbox.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • _config.yml (1 hunks)
  • _data/sidebars/flexberry-ember-3_sidebar.yml (1 hunks)
  • css/customstyles.css (2 hunks)
  • css/theme-flexberry.css (2 hunks)
  • pages/products/flexberry-ember/3.x/components/ef3_edit-form-components.ru.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/products/flexberry-ember/3.x/components/ef3_edit-form-components.ru.md

[uncategorized] ~35-~35: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...тва flexberry-field Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~69-~69: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...а flexberry-textbox Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~104-~104: Перед знаками препинания не должно быть пробела: «описание:»
Context: ... flexberry-textarea Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~139-~139: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...erry-simpledatetime Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~178-~178: Перед знаками препинания не должно быть пробела: «описание:»
Context: ... flexberry-checkbox Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~207-~207: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...berry-ddau-checkbox Свойство | Краткое описание :--------|:---------------- readonly | ...

(Punct_and_spaces)


[uncategorized] ~238-~238: Перед знаками препинания не должно быть пробела: «описание:»
Context: ... flexberry-dropdown Свойство | Краткое описание :--------|:---------------- Свойства `com...

(Punct_and_spaces)


[uncategorized] ~271-~271: Перед знаками препинания не должно быть пробела: «описание:»
Context: ... flexberry-jsonarea Свойство | Краткое описание :--------|:---------------- readonly | ...

(Punct_and_spaces)


[uncategorized] ~318-~318: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...lexberry-edit-panel Свойство | Краткое описание :--------|:---------------- `showCloseBut...

(Punct_and_spaces)


[uncategorized] ~347-~347: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...ва flexberry-button Свойство | Краткое описание :--------|:---------------- readonly | ...

(Punct_and_spaces)


[duplication] ~355-~355: Возможная опечатка: повтор слова
Context: ...on/settings-example) flexberry-button на на тестовом стенде. ### flexberry-ddau-sl...

(WORD_REPEAT_RULE)


[uncategorized] ~380-~380: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...exberry-ddau-slider Свойство | Краткое описание :--------|:---------------- readonly | ...

(Punct_and_spaces)


[uncategorized] ~408-~408: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...exberry-colorpicker Свойство | Краткое описание :--------|:---------------- classNames ...

(Punct_and_spaces)

🔇 Additional comments (8)
_data/sidebars/flexberry-ember-3_sidebar.yml (1)

93-96: Корректное добавление нового раздела в боковую панель!

Новый элемент меню логически вписывается в раздел компонентов, имеет правильную структуру и соответствует общему стилю оформления документации.

_config.yml (2)

57-57: Необходима документация тестовых стендов

В связи с добавлением нового URL тестового стенда, рекомендуется:

  1. Создать централизованный список всех актуальных URL тестовых стендов
  2. Документировать назначение каждого стенда
  3. Проверить и удалить неактуальные URL из кодовой базы
#!/bin/bash
# Проверка использования старых URL тестовых стендов
rg -i "flexberry.github.io/ember-flexberry/dummy" --type yml

57-58: Проверьте доступность URL

Убедитесь, что:

  1. URL тестового стенда доступен и корректно работает
  2. Версия компонентов на стенде соответствует документации 3.x
  3. Примеры в документации корректно ссылаются на данный URL
css/theme-flexberry.css (2)

62-62: Изменение веса шрифта для h4 выглядит корректно!

Уменьшение веса шрифта с 500 до 400 создает более гармоничную визуальную иерархию с другими заголовками.


226-227: Стилизация .item-head соответствует общей теме!

Добавление фирменного цвета (#650f8b) и увеличенного веса шрифта (500) улучшает визуальную иерархию и поддерживает единый стиль оформления.

pages/products/flexberry-ember/3.x/components/ef3_edit-form-components.ru.md (1)

147-147: ⚠️ Potential issue

Исправить опечатку и пунктуацию.

В описании свойства useBrowserInput содержится опечатка и пропущена запятая.

-useBrowserInput` | Флаг, определяющий нужно ли использовать импут браузера
+useBrowserInput` | Флаг, определяющий, нужно ли использовать инпут браузера

Likely invalid or redundant comment.

css/customstyles.css (2)

628-629: Улучшение контрастности и читаемости заголовков.

Изменения улучшают визуальную иерархию:

  • Цвет h4 изменен на более контрастный (#333333)
  • Удален font-weight для h3, что может сделать заголовки более согласованными

Рекомендуется проверить, соответствуют ли новые стили требованиям по доступности WCAG 2.1.

#!/bin/bash
# Поиск использования заголовков h3 и h4 в markdown файлах
rg -l "^###|^####" 

79-81: Проверьте корректность отступов при прокрутке к якорям.

Увеличение padding-top с 90px до 100px может повлиять на позиционирование при прокрутке к якорям. Убедитесь, что увеличенный отступ не приводит к перекрытию заголовков другими элементами.

✅ Verification successful

Let me analyze the results and generate additional verification scripts to check the impact of the padding-top change.


Let me check the scroll-related JavaScript code to understand how the padding affects the scrolling behavior.


Изменение padding-top безопасно для прокрутки к якорям

На основе анализа JavaScript-кода и использования якорей в документации можно сделать вывод, что увеличение padding-top с 90px до 100px является безопасным изменением:

  • Сайт использует библиотеку jquery.scrollTo для плавной прокрутки к якорям
  • Библиотека автоматически учитывает отступы при расчете позиции прокрутки
  • Новое значение padding-top (100px) обеспечивает достаточный отступ, чтобы заголовки не перекрывались фиксированной навигацией
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Проверяем, есть ли якоря в markdown файлах
rg -l "^#.*\{#.*\}" 

Length of output: 45132


Script:

#!/bin/bash
# Проверяем использование якорей в markdown файлах
rg -l "id=\".*\"" pages/

# Проверяем наличие скриптов для прокрутки к якорям
rg -l "scrollTo|scroll" js/

Length of output: 3657


Script:

#!/bin/bash
# Проверяем содержимое файлов со скроллингом
cat js/customscripts.js
cat js/jquery.scrollTo.min.js
cat js/jquery.localScroll.min.js

Length of output: 6326

`tooltip` | Определяет текст подсказки компонента.
`iconClass` |Определяет css-class для иконки компонент.

[Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на на тестовом стенде.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Исправить дублирование предлога.

В ссылке на пример содержится повторение предлога "на".

-[Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на на тестовом стенде.
+[Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на тестовом стенде.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на на тестовом стенде.
[Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на тестовом стенде.
🧰 Tools
🪛 LanguageTool

[duplication] ~355-~355: Возможная опечатка: повтор слова
Context: ...on/settings-example) flexberry-button на на тестовом стенде. ### flexberry-ddau-sl...

(WORD_REPEAT_RULE)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants