HTMLElement.h

//  HTMLElement.h
//
//  Public domain. https://github.com/nolanw/HTMLReader

#import <HTMLReader/HTMLNode.h>

NS_ASSUME_NONNULL_BEGIN

/**
    An HTMLElement represents a subtree of content in an HTML document.
 
    For more information, see http://www.whatwg.org/specs/web-apps/current-work/multipage/elements.html#elements
 */
@interface HTMLElement : HTMLNode

/**
    Initializes an element with a tag name and attributes.
 
    @param tagName    What kind of element to make.
    @param attributes A dictionary of attributes to start the element off. May be nil.
 */
- (instancetype)initWithTagName:(NSString *)tagName attributes:(HTMLDictOf(NSString *, NSString *) * __nullable)attributes NS_DESIGNATED_INITIALIZER;

/// The element's kind.
@property (readonly, copy, nonatomic) NSString *tagName;

/**
    The element's attributes.
 
    The attributes' sort order is stable when serialized. (This is required by the spec, but is not guaranteed by NSDictionary.)
 
    @see -objectForKeyedSubscript:
    @see -setObject:forKeyedSubscript:
    @see -removeAttributeWithName:
 */
@property (readonly, copy, nonatomic) HTMLDictOf(NSString *, NSString *) *attributes;

/// Returns the value of the named attribute, or nil if no such value exists.
- (id __nullable)objectForKeyedSubscript:(id)attributeNameOrString;

/// Sets a named attribute's value, adding it to the element if needed.
- (void)setObject:(NSString *)attributeValue forKeyedSubscript:(NSString *)attributeName;

/// Removes the named attribute from the element.
- (void)removeAttributeWithName:(NSString *)attributeName;

/// Whether or not a name appears in the element's class attribute.
- (BOOL)hasClass:(NSString *)className;

/// If the name appears in the element's class attribute, remove it; otherwise, add it.
- (void)toggleClass:(NSString *)className;

/// This element's namespace.
@property (assign, nonatomic) HTMLNamespace htmlNamespace;

@end

NS_ASSUME_NONNULL_END