boreal-ui 0.0.75 → 0.0.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8297,7 +8297,7 @@ const typographyPropDocs = {
8297
8297
  {
8298
8298
  "name": "align",
8299
8299
  "type": "TypographyAlign",
8300
- "description": "",
8300
+ "description": "Horizontal text alignment.",
8301
8301
  "required": false,
8302
8302
  "inherited": false,
8303
8303
  "category": "props"
@@ -8305,7 +8305,7 @@ const typographyPropDocs = {
8305
8305
  {
8306
8306
  "name": "aria-atomic",
8307
8307
  "type": "boolean",
8308
- "description": "",
8308
+ "description": "Whether assistive technologies should present the entire updated region when part of a live region changes.",
8309
8309
  "required": false,
8310
8310
  "inherited": false,
8311
8311
  "category": "aria"
@@ -8313,7 +8313,7 @@ const typographyPropDocs = {
8313
8313
  {
8314
8314
  "name": "aria-busy",
8315
8315
  "type": "boolean",
8316
- "description": "",
8316
+ "description": "Indicates whether the element is currently being updated, such as during loading.",
8317
8317
  "required": false,
8318
8318
  "inherited": false,
8319
8319
  "category": "aria"
@@ -8321,7 +8321,7 @@ const typographyPropDocs = {
8321
8321
  {
8322
8322
  "name": "aria-describedby",
8323
8323
  "type": "string",
8324
- "description": "",
8324
+ "description": "References the id of another element that describes this element.",
8325
8325
  "required": false,
8326
8326
  "inherited": false,
8327
8327
  "category": "aria"
@@ -8329,7 +8329,7 @@ const typographyPropDocs = {
8329
8329
  {
8330
8330
  "name": "aria-hidden",
8331
8331
  "type": "boolean",
8332
- "description": "",
8332
+ "description": "Whether the element should be hidden from assistive technologies.",
8333
8333
  "required": false,
8334
8334
  "inherited": false,
8335
8335
  "category": "aria"
@@ -8337,7 +8337,7 @@ const typographyPropDocs = {
8337
8337
  {
8338
8338
  "name": "aria-label",
8339
8339
  "type": "string",
8340
- "description": "",
8340
+ "description": "Defines an accessible label for the element when a visible label is not sufficient.",
8341
8341
  "required": false,
8342
8342
  "inherited": false,
8343
8343
  "category": "aria"
@@ -8345,7 +8345,7 @@ const typographyPropDocs = {
8345
8345
  {
8346
8346
  "name": "aria-labelledby",
8347
8347
  "type": "string",
8348
- "description": "",
8348
+ "description": "References the id of another element that labels this element.",
8349
8349
  "required": false,
8350
8350
  "inherited": false,
8351
8351
  "category": "aria"
@@ -8353,7 +8353,7 @@ const typographyPropDocs = {
8353
8353
  {
8354
8354
  "name": "aria-live",
8355
8355
  "type": '"off" | "polite" | "assertive"',
8356
- "description": "",
8356
+ "description": "Indicates that the element will be updated and describes how updates should be announced.",
8357
8357
  "required": false,
8358
8358
  "inherited": false,
8359
8359
  "category": "aria"
@@ -8361,7 +8361,7 @@ const typographyPropDocs = {
8361
8361
  {
8362
8362
  "name": "as",
8363
8363
  "type": "ElementType",
8364
- "description": "",
8364
+ "description": 'The HTML element or custom component to render as. For example: `"p"`, `"span"`, `"h1"`, or a custom React component.',
8365
8365
  "required": false,
8366
8366
  "inherited": false,
8367
8367
  "category": "props"
@@ -8369,7 +8369,7 @@ const typographyPropDocs = {
8369
8369
  {
8370
8370
  "name": "children",
8371
8371
  "type": "ReactNode",
8372
- "description": "",
8372
+ "description": "The content to render inside the typography component.",
8373
8373
  "required": false,
8374
8374
  "inherited": false,
8375
8375
  "category": "props"
@@ -8377,7 +8377,7 @@ const typographyPropDocs = {
8377
8377
  {
8378
8378
  "name": "className",
8379
8379
  "type": "string",
8380
- "description": "",
8380
+ "description": "Optional custom CSS class name for the root element.",
8381
8381
  "required": false,
8382
8382
  "inherited": false,
8383
8383
  "category": "styling"
@@ -8385,7 +8385,7 @@ const typographyPropDocs = {
8385
8385
  {
8386
8386
  "name": "id",
8387
8387
  "type": "string",
8388
- "description": "",
8388
+ "description": "Optional unique id for the root element.",
8389
8389
  "required": false,
8390
8390
  "inherited": false,
8391
8391
  "category": "props"
@@ -8393,7 +8393,7 @@ const typographyPropDocs = {
8393
8393
  {
8394
8394
  "name": "italic",
8395
8395
  "type": "boolean",
8396
- "description": "",
8396
+ "description": "Whether the text should be displayed in italic style.",
8397
8397
  "required": false,
8398
8398
  "inherited": false,
8399
8399
  "category": "props"
@@ -8401,7 +8401,7 @@ const typographyPropDocs = {
8401
8401
  {
8402
8402
  "name": "noWrap",
8403
8403
  "type": "boolean",
8404
- "description": "",
8404
+ "description": "Whether the text should remain on a single line without wrapping.",
8405
8405
  "required": false,
8406
8406
  "inherited": false,
8407
8407
  "category": "props"
@@ -8409,7 +8409,7 @@ const typographyPropDocs = {
8409
8409
  {
8410
8410
  "name": "role",
8411
8411
  "type": "AriaRole",
8412
- "description": "",
8412
+ "description": "Optional ARIA role for the rendered element.",
8413
8413
  "required": false,
8414
8414
  "inherited": false,
8415
8415
  "category": "aria"
@@ -8417,7 +8417,7 @@ const typographyPropDocs = {
8417
8417
  {
8418
8418
  "name": "srOnly",
8419
8419
  "type": "boolean",
8420
- "description": "",
8420
+ "description": "Whether the text should be visually hidden but still available to screen readers.",
8421
8421
  "required": false,
8422
8422
  "inherited": false,
8423
8423
  "category": "props"
@@ -8425,7 +8425,7 @@ const typographyPropDocs = {
8425
8425
  {
8426
8426
  "name": "style",
8427
8427
  "type": "CSSProperties",
8428
- "description": "",
8428
+ "description": "Optional inline styles applied to the root element.",
8429
8429
  "required": false,
8430
8430
  "inherited": false,
8431
8431
  "category": "props"
@@ -8433,7 +8433,7 @@ const typographyPropDocs = {
8433
8433
  {
8434
8434
  "name": "testId",
8435
8435
  "type": "string",
8436
- "description": "",
8436
+ "description": "Optional test id used for testing the component.",
8437
8437
  "required": false,
8438
8438
  "inherited": false,
8439
8439
  "category": "props"
@@ -8441,7 +8441,7 @@ const typographyPropDocs = {
8441
8441
  {
8442
8442
  "name": "theme",
8443
8443
  "type": "TypographyTheme",
8444
- "description": "",
8444
+ "description": "Visual theme style applied to the typography.",
8445
8445
  "required": false,
8446
8446
  "inherited": false,
8447
8447
  "category": "styling"
@@ -8449,7 +8449,7 @@ const typographyPropDocs = {
8449
8449
  {
8450
8450
  "name": "title",
8451
8451
  "type": "string",
8452
- "description": "",
8452
+ "description": "Advisory text for the element, typically shown as a tooltip on hover.",
8453
8453
  "required": false,
8454
8454
  "inherited": false,
8455
8455
  "category": "props"
@@ -8457,7 +8457,7 @@ const typographyPropDocs = {
8457
8457
  {
8458
8458
  "name": "truncate",
8459
8459
  "type": "boolean",
8460
- "description": "",
8460
+ "description": "Whether overflowing text should be truncated, typically with an ellipsis.",
8461
8461
  "required": false,
8462
8462
  "inherited": false,
8463
8463
  "category": "props"
@@ -8465,7 +8465,7 @@ const typographyPropDocs = {
8465
8465
  {
8466
8466
  "name": "underline",
8467
8467
  "type": "boolean",
8468
- "description": "",
8468
+ "description": "Whether the text should be underlined.",
8469
8469
  "required": false,
8470
8470
  "inherited": false,
8471
8471
  "category": "props"
@@ -8473,7 +8473,7 @@ const typographyPropDocs = {
8473
8473
  {
8474
8474
  "name": "variant",
8475
8475
  "type": "TypographyVariant",
8476
- "description": "",
8476
+ "description": "Predefined typography style variant. Examples may include headings, body text, captions, or labels.",
8477
8477
  "required": false,
8478
8478
  "inherited": false,
8479
8479
  "category": "props"
@@ -8481,7 +8481,7 @@ const typographyPropDocs = {
8481
8481
  {
8482
8482
  "name": "weight",
8483
8483
  "type": "TypographyWeight",
8484
- "description": "",
8484
+ "description": "Font weight of the text.",
8485
8485
  "required": false,
8486
8486
  "inherited": false,
8487
8487
  "category": "props"