diff --git a/packages/plasma-new-hope/src/components/Button/Button.docs.mdx b/packages/plasma-new-hope/src/components/Button/Button.docs.mdx new file mode 100644 index 0000000000..c838ac12d0 --- /dev/null +++ b/packages/plasma-new-hope/src/components/Button/Button.docs.mdx @@ -0,0 +1,162 @@ +--- +id: button +title: Button +--- + +import { PropsTable, Description } from '@site/src/components'; + +# Button +Кнопки могут отображаться в нескольких размерах и цветах, могут содержать текст и/или иконку. + +## Button + + + +## Использование +Компонент `Button` может содержать текст, который указывается в +свойстве `text`, или любой контент напрямую через `children`. + +Свойство text можно использовать вместе со свойствами `contentLeft` и `contentRight`. +С их помощью можно размещать **иконку** слева или справа от текста. + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; +import { IconDownload } from '@salutejs/plasma-icons'; + +export function App() { + return ( +
+
} /> + + + + ); +} +``` + +## Примеры + +### Размер кнопки +Размер кнопки задается с помощью свойства `size`. Возможные значения свойства: `"l"`, `"m"` или `"s"`: + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; + +export function App() { + return ( +
+
+ ); +} +``` + +### Вид кнопки +Вид кнопки задается с помощью свойства `view`. Возможные значения свойства `view`: ++ `"primary"` – основная; ++ `"secondary"` – вторичная; ++ `"success"` – успешное завершение; ++ `"warning"` – предупреждение; ++ `"critical"` – ошибка; ++ `"checked"` – выбранное состояние; ++ `"clear"` – без цветового сопровождения. + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; + +export function App() { + return ( +
+
+ ); +} +``` + +### Границы кнопки +Границы кнопки задаются с помощью свойства `pin`. Возможные значения свойства `pin`: ++ `square` – обычное скругление; ++ `circle` – сильное скругление; ++ `clear` – нет скругления. + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; + +export function App() { + return ( +
+ + + + + + + +
+ ); +} +``` + +### Квадратные и круглые кнопки +Для отображения иконок и/или текста в квадратных или круглых кнопках с **равными сторонами**, +используйте компонент `Button` и свойство `contentLeft`, в которое требуется передать нужное значение. + +По умолчанию границы кнопки **квадратные** (со скругленными углами) — `pin="square-square"`. +**Круглые** границы кнопки можно сделать с помощью свойства `pin` со значением `"circle-circle"`. + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; +import { IconDownload } from '@salutejs/plasma-icons'; + +export function App() { + return ( +
+
+ ); +} +``` + +### Гиперссылка +Компонент поддерживает вывод в виде тега ``, для этого необходимо указать свойство `as`: + +```tsx live +import React from 'react'; +import { Button } from '@salutejs/{{package}}'; +import { IconDownload } from '@salutejs/plasma-icons'; + +export function App() { + return ( +