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

Exhaustive list of all broken anchors found #764

Open
shalugin opened this issue Jan 20, 2025 · 0 comments
Open

Exhaustive list of all broken anchors found #764

shalugin opened this issue Jan 20, 2025 · 0 comments
Labels
bug Issue raised as a bug.

Comments

@shalugin
Copy link

What package is the bug related to?

docusaurus-plugin-typedoc

Describe the issue

After updating docusaurus-plugin-typedoc to version 1.2.0, I noticed that it adds a lot more headers to documents. And it breaks some anchors. In version 1.2.2 the behaviour is the same.

[WARNING] Docusaurus found broken anchors!

Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.

Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /documentation/api-reference/@react-form-builder/core/classes/TemplateField:
   -> linking to /documentation/api-reference/@react-form-builder/core/interfaces/Field#value-2
- Broken anchor on source page path = /documentation/api-reference/@react-form-builder/designer/interfaces/SelectCellProps:
   -> linking to /documentation/api-reference/@react-form-builder/designer/interfaces/InputCellProps#rowdata-4
   -> linking to /documentation/api-reference/@react-form-builder/designer/interfaces/InputCellProps#rowindex-4
   -> linking to /documentation/api-reference/@react-form-builder/designer/interfaces/InputCellProps#rowkey-2

Generated Field.md:

# Interface: Field

Field with the form data.

## Properties

### clear()

> **clear**: () => `void`

Clears the data in the field.

#### Returns

`void`

***

### dispose()

> **dispose**: () => `void`

Releases allocated resources, must be used when destroying an object instance.

#### Returns

`void`

***

### error?

> `optional` **error**: `string`

Contains a field validation error if the field data is not valid.

***

### errors?

> `optional` **errors**: `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]

Contains a field validation errors if the field provides multiple errors (i.e. field is template).
Contains an array of field validation errors if the field contains an array of components.

***

### fieldType

> **fieldType**: [`FieldType`](../type-aliases/FieldType.md)

The field type.

***

### getValidationResult()

> **getValidationResult**: () => `Promise`\<[`ValidationMessages`](../type-aliases/ValidationMessages.md) \| [`ValidationMessages`](../type-aliases/ValidationMessages.md)[]\>

Returns the validation results without triggering an events and changing the state of the form.

#### Returns

`Promise`\<[`ValidationMessages`](../type-aliases/ValidationMessages.md) \| [`ValidationMessages`](../type-aliases/ValidationMessages.md)[]\>

the [ValidationMessages](../type-aliases/ValidationMessages.md) validation results.

***

### init()

> **init**: () => `void`

Initializes the value of the field.

#### Returns

`void`

***

### reset()

> **reset**: () => `void`

Sets the field to its default value.

#### Returns

`void`

***

### setError()

> **setError**: (`error`) => `void`

Sets the error value.

#### Parameters

##### error

`unknown`

The error value to be set.

#### Returns

`void`

***

### setTouched()

> **setTouched**: () => `void`

Marks the field as touched.

#### Returns

`void`

***

### setValue()

> **setValue**: (`value`) => `void`

Sets the value of the field.

#### Parameters

##### value

`unknown`

the value.

#### Returns

`void`

***

### storeDataInParentForm?

> `optional` **storeDataInParentForm**: `boolean`

Flag, false if nested form data show as nested object, true otherwise.

***

### touched

> **touched**: `boolean`

Flag, true, if the field is marked as touched.

***

### validate()

> **validate**: () => `Promise`\<`void`\>

Validates the field value.

#### Returns

`Promise`\<`void`\>

***

### value

> **value**: `unknown`

Value of the field.

***

### valued

> **valued**: `string`

The name of the component property that contains the field value.

TemplateField.md:

# Class: TemplateField

The field with the form data, contains the value of the nested form. **Internal use only.**

## Implements

- [`Field`](../interfaces/Field.md)

## Constructors

### new TemplateField()

> **new TemplateField**(`componentStore`, `viewerStore`): [`TemplateField`](TemplateField.md)

Creates the nested form field with form data for the component.

#### Parameters

##### componentStore

[`ComponentStore`](ComponentStore.md)

the component settings.

##### viewerStore

[`IStore`](../interfaces/IStore.md)

viewerStore the form viewer settings.

#### Returns

[`TemplateField`](TemplateField.md)

## Properties

### componentStore

> `readonly` **componentStore**: [`ComponentStore`](ComponentStore.md)

the component settings.

***

### touched

> **touched**: `boolean` = `false`

Flag, true, if the field is marked as touched.

#### Implementation of

[`Field`](../interfaces/Field.md).[`touched`](../interfaces/Field.md#touched)

***

### valued

> **valued**: `string` = `''`

The name of the component property that contains the field value.

#### Implementation of

[`Field`](../interfaces/Field.md).[`valued`](../interfaces/Field.md#valued)

***

### viewerStore

> `readonly` **viewerStore**: [`IStore`](../interfaces/IStore.md)

viewerStore the form viewer settings.

## Accessors

### errors

#### Get Signature

> **get** **errors**(): `Record`\<`string`, `unknown`\>

Contains a field validation errors if the field provides multiple errors (i.e. field is template).
Contains an array of field validation errors if the field contains an array of components.

##### Returns

`Record`\<`string`, `unknown`\>

Contains a field validation errors if the field provides multiple errors (i.e. field is template).
Contains an array of field validation errors if the field contains an array of components.

#### Implementation of

[`Field`](../interfaces/Field.md).[`errors`](../interfaces/Field.md#errors)

***

### fieldType

#### Get Signature

> **get** **fieldType**(): [`FieldType`](../type-aliases/FieldType.md)

The field type.

##### Returns

[`FieldType`](../type-aliases/FieldType.md)

The field type.

#### Implementation of

[`Field`](../interfaces/Field.md).[`fieldType`](../interfaces/Field.md#fieldtype)

***

### form

#### Get Signature

> **get** **form**(): [`ComponentData`](ComponentData.md)

##### Returns

[`ComponentData`](ComponentData.md)

the form for the field.

***

### storeDataInParentForm

#### Get Signature

> **get** **storeDataInParentForm**(): `any`

Flag, false if nested form data show as nested object, true otherwise.

##### Returns

`any`

Flag, false if nested form data show as nested object, true otherwise.

#### Implementation of

[`Field`](../interfaces/Field.md).[`storeDataInParentForm`](../interfaces/Field.md#storedatainparentform)

***

### value

#### Get Signature

> **get** **value**(): `Record`\<`string`, `unknown`\>

Value of the field.

##### Returns

`Record`\<`string`, `unknown`\>

Value of the field.

#### Implementation of

[`Field`](../interfaces/Field.md).[`value`](../interfaces/Field.md#value-2)

## Methods

### clear()

> **clear**(): `void`

Clears the data in the field.

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`clear`](../interfaces/Field.md#clear)

***

### dispose()

> **dispose**(): `void`

Releases allocated resources, must be used when destroying an object instance.

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`dispose`](../interfaces/Field.md#dispose)

***

### getValidationResult()

> **getValidationResult**(): `Promise`\<`undefined`\>

Returns the validation results without triggering an events and changing the state of the form.

#### Returns

`Promise`\<`undefined`\>

the [ValidationMessages](../type-aliases/ValidationMessages.md) validation results.

#### Implementation of

[`Field`](../interfaces/Field.md).[`getValidationResult`](../interfaces/Field.md#getvalidationresult)

***

### init()

> **init**(): `void`

Initializes the value of the field.

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`init`](../interfaces/Field.md#init)

***

### reset()

> **reset**(): `void`

Sets the field to its default value.

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`reset`](../interfaces/Field.md#reset)

***

### setError()

> **setError**(`error`): `void`

Sets the error value.

#### Parameters

##### error

`unknown`

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`setError`](../interfaces/Field.md#seterror)

***

### setTouched()

> **setTouched**(): `void`

Marks the field as touched.

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`setTouched`](../interfaces/Field.md#settouched)

***

### setValue()

> **setValue**(`value`): `void`

Sets the value of the field.

#### Parameters

##### value

`unknown`

#### Returns

`void`

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`setValue`](../interfaces/Field.md#setvalue)

***

### validate()

> **validate**(): `Promise`\<`void`\>

Validates the field value.

#### Returns

`Promise`\<`void`\>

#### Inherit Doc

#### Implementation of

[`Field`](../interfaces/Field.md).[`validate`](../interfaces/Field.md#validate)

TypeDoc configuration

  "devDependencies": {
    "@docusaurus/module-type-aliases": "^3.5.2",
    "@docusaurus/tsconfig": "^3.5.2",
    "@docusaurus/types": "^3.5.2",
    "docusaurus-plugin-typedoc": "^1.2.2",
    "typedoc": "^0.27.6",
    "typedoc-plugin-markdown": "^4.4.1",
    "typescript": "~5.2.2"
  },

Expected behavior

No response

@shalugin shalugin added the bug Issue raised as a bug. label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue raised as a bug.
Projects
None yet
Development

No branches or pull requests

1 participant