Add ef3_edit-form-components page #166
Conversation
| `placeholder` | Определяет placeholder. | ||
| `label` | Определяет заголовок поля. | ||
| `classNames` | Определяет css-class на компонент. | ||
| `type` | Определяет вид компонента. |
There was a problem hiding this comment.
Интересен список доступных вариантов, что в type можно записать.
| `classNames` | Определяет css-class на компонент. | ||
| `type` | Определяет вид компонента. | ||
| `maxlength` | Определяет максимальное количество символов (в единицах кода UTF-16), которое может ввести пользователь. | ||
| `appConfigSettingsPath` | Определяет путь к настройкам компонента в конфигурации приложения. |
There was a problem hiding this comment.
Мне как пользователю был бы интересен пример, что в appConfigSettingsPath стоит писать.
| `classNames` | Определяет css-class на компонент. | ||
| `defaultMinute` | Определяет значение минут по умолчанию. | ||
| `defaultHour` | Определяет значение часов по умолчанию. | ||
| `useBrowserInput` | Флаг, определяющий нужно ли использовать импут браузера |
| `classNames` | Определяет css-class на компонент. | ||
| `appConfigSettingsPath` | Определяет путь к настройкам компонента в конфигурации приложения. | ||
| `rows` | Определяет количество строк таблицы, связанных с текстовой областью. | ||
| `cols` | Определяет количество столбцов таблицы, связанных с текстовой областью. |
There was a problem hiding this comment.
Непонятно, о какой таблице идёт речь.
|
|
||
| ### flexberry-simpledatetime | ||
|
|
||
| `flexberry-simpledatetime` - компонент для отображения даты/даты и времени. |
There was a problem hiding this comment.
Очень странно выглядит формулировка, если честно.
| `classNames` | Определяет css-class на компонент. | ||
| `defaultMinute` | Определяет значение минут по умолчанию. | ||
| `defaultHour` | Определяет значение часов по умолчанию. | ||
| `useBrowserInput` | Флаг, определяющий нужно ли использовать импут браузера |
There was a problem hiding this comment.
Пропущена запятая "определяющий, нужно".
| `min` | Определяет самую раннюю дату, которую пользователь может выбрать. | ||
| `max` | Определяет самую последнюю дату, которую пользователь может выбрать. | ||
| `type` | Определяет вид компонента. | ||
| `canClick` | Флаг, определяющий нужно ли onClick вызывать flatpickr.open() |
There was a problem hiding this comment.
Пропущена запятая "определяющий, нужно".
| `min` | Определяет самую раннюю дату, которую пользователь может выбрать. | ||
| `max` | Определяет самую последнюю дату, которую пользователь может выбрать. | ||
| `type` | Определяет вид компонента. | ||
| `canClick` | Флаг, определяющий нужно ли onClick вызывать flatpickr.open() |
There was a problem hiding this comment.
Непонятно, что за flatpickr и что с ним делать.
|
|
||
| ### flexberry-ddau-checkbox | ||
|
|
||
| `flexberry-ddau-checkbox` - компонент для отображения логических данных. |
There was a problem hiding this comment.
Может сразу указать, чем он принципиально отличается от flexberry-checkbox?
| Свойства `componentName` и `readonly` | Свойства из [базового контрола](ef2_base-component.html). | ||
| `value` | Определяет значение, которое будет отображаться. | ||
| `class` | Определяет css-class на компонент. | ||
| `items` | Определяет перечисление. |
There was a problem hiding this comment.
Не очень понятно написано.
| class="save-button" | ||
| disabled=(readonly) | ||
| text=(t "forms.edit-form.save-button-text") | ||
| action="save") |
There was a problem hiding this comment.
А про структуру
(hash
type="submit"
class="save-button"
disabled=(readonly)
text=(t "forms.edit-form.save-button-text")
action="save")
будет в документации?
| Свойство | Краткое описание | ||
| :--------|:---------------- | ||
| `showCloseButton` | Определяет, показывать ли кнопку Закрыть в тулбаре. По умолчанию данное свойство имеет значение `false`. | ||
| `deepMount` | Определяет вычитку действий кнопок. По умолчанию данное свойство имеет значение `false`. |
| Свойство | Краткое описание | ||
| :--------|:---------------- | ||
| `readonly` | Определяет, доступен ли объект только для чтения. По умолчанию данное свойство имеет значение `false`. | ||
| `classNames` | Определяет css-class на компонент. |
There was a problem hiding this comment.
Опечатка? "Определяет css-class компонента."?
| `readonly` | Определяет, доступен ли объект только для чтения. По умолчанию данное свойство имеет значение `false`. | ||
| `classNames` | Определяет css-class на компонент. | ||
| `value` | Определяет значение, которое будет отображаться. | ||
| `min` | Определяет минимальное значение компонента. |
There was a problem hiding this comment.
В каких единицах указывать? Это натуральное число или дроби можно?
WalkthroughВ данном пулл-реквесте внесены изменения в несколько файлов конфигурации и стилей для проекта Flexberry Ember. В файл Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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не указаны возможные значения и примеры использования, что затрудняет понимание их применения.Предлагаю добавить:
- Список допустимых значений для свойства
type- Пример конфигурации для
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
⛔ Files ignored due to path filters (11)
images/favicon.icois excluded by!**/*.icoimages/pages/products/flexberry-ember/3.x/components/flexberry-button.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-checkbox.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-ddau-slider.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-dropdown.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-edit-panel.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-field.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-jsonarea.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-simpledatetime.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-textarea.pngis excluded by!**/*.pngimages/pages/products/flexberry-ember/3.x/components/flexberry-textbox.pngis 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 тестового стенда, рекомендуется:
- Создать централизованный список всех актуальных URL тестовых стендов
- Документировать назначение каждого стенда
- Проверить и удалить неактуальные URL из кодовой базы
#!/bin/bash # Проверка использования старых URL тестовых стендов rg -i "flexberry.github.io/ember-flexberry/dummy" --type yml
57-58: Проверьте доступность URLУбедитесь, что:
- URL тестового стенда доступен и корректно работает
- Версия компонентов на стенде соответствует документации 3.x
- Примеры в документации корректно ссылаются на данный 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.jsLength of output: 6326
| `tooltip` | Определяет текст подсказки компонента. | ||
| `iconClass` |Определяет css-class для иконки компонент. | ||
|
|
||
| [Пример работы с настройками]({{site.test_stand_3x_url}}/#/components-examples/flexberry-button/settings-example) `flexberry-button` на на тестовом стенде. |
There was a problem hiding this comment.
Исправить дублирование предлога.
В ссылке на пример содержится повторение предлога "на".
-[Пример работы с настройками]({{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.
| [Пример работы с настройками]({{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)
Summary by CodeRabbit
Новые функции
test_stand_3x_urlдля документации.Изменения в стилях
Документация