Skip to content

Conversation

@willeastcott
Copy link
Contributor

This PR improves and corrects the JSDoc API reference documentation across multiple PCUI components.

Bug Fixes

  • ArrayInput: Fixed EVENT_LINK_ELEMENT and EVENT_UNLINK_ELEMENT constants that used : instead of = (TypeScript syntax error)
  • NumericInput: Fixed incorrect default value for precision in JSDoc (was "2", should be "7")

Documentation Improvements

Event Constants Added

Added properly documented static event constants with @event tags and usage examples to:

  • NumericInput: EVENT_CHANGE, EVENT_SLIDER_MOUSEDOWN, EVENT_SLIDER_MOUSEUP
  • SelectInput: EVENT_CHANGE, EVENT_FOCUS, EVENT_BLUR
  • VectorInput: EVENT_CHANGE, EVENT_FOCUS, EVENT_BLUR

Missing JSDoc Added

  • Button: focus(), blur() methods
  • Label: value, values, placeholder, renderChanges properties
  • InputElement: focus(), blur() methods with parameter documentation
  • TextInput: values setter
  • NumericInput: value getter/setter, values setter
  • ArrayInput: value getter/setter, values setter, renderChanges getter/setter
  • VectorInput: focus(), blur() methods, value, values, binding, placeholder, inputs, renderChanges properties
  • SelectInput: focus(), blur() methods, options, invalidOptions, disabledValue, disabledOptions, fallbackOrder, multiSelect, value, values, placeholder, renderChanges properties

@willeastcott willeastcott requested a review from Copilot December 30, 2025 07:59
@willeastcott willeastcott self-assigned this Dec 30, 2025
@willeastcott willeastcott added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Dec 30, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes critical TypeScript syntax errors and significantly improves JSDoc API reference documentation across PCUI components by adding missing documentation and correcting inaccurate defaults.

  • Fixed TypeScript syntax errors in ArrayInput event constants (using : instead of =)
  • Corrected NumericInput precision default documentation from "2" to "7"
  • Added comprehensive event constant documentation with usage examples for NumericInput, SelectInput, and VectorInput
  • Documented previously undocumented methods and properties across 8 components

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/components/ArrayInput/index.ts Fixed TypeScript syntax for EVENT_LINK_ELEMENT and EVENT_UNLINK_ELEMENT constants, added JSDoc for value/values/renderChanges properties
src/components/NumericInput/index.ts Corrected precision default from 2 to 7, added EVENT constants with examples, documented value/values properties
src/components/SelectInput/index.ts Added EVENT constants with examples, documented focus/blur methods and all property getters/setters
src/components/VectorInput/index.ts Added EVENT constants with examples, documented focus/blur methods and all properties
src/components/TextInput/index.ts Added JSDoc for values setter
src/components/Label/index.ts Added JSDoc for value, values, placeholder, and renderChanges properties
src/components/InputElement/index.ts Added JSDoc for focus and blur methods with parameter documentation
src/components/Button/index.ts Added JSDoc for focus and blur methods

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@willeastcott willeastcott merged commit 88b563e into main Dec 30, 2025
5 checks passed
@willeastcott willeastcott deleted the better-docs branch December 30, 2025 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants